docs: Improve {ISSUE,PULL_REQUEST}_TEMPLATEs, slightly (#464)

This patch is a follow-up of PR #453
ocaml-sf · Jan 21, 2022 · e3ff435 · e3ff435
1 parent 6e3fa0f
commit e3ff435
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -40,9 +40,11 @@ Steps to reproduce the behavior:
 
 ## Current configuration
 
+<!-- You can write "N/A" for the items that sound irrelevant to you -->
 * OS name (and version): 
 * Browser name (and version): 
 * `learn-ocaml --version`: 
+* `git describe --long --always --abbrev=40`: 
 
 ## Additional context
 

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -28,9 +28,11 @@ assignees: ''
 
 ## Current configuration
 
+<!-- You can write "N/A" for the items that sound irrelevant to you -->
 * OS name (and version): 
 * Browser name (and version): 
 * `learn-ocaml --version`: 
+* `git describe --long --always --abbrev=40`: 
 
 ## Additional context
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -28,3 +28,4 @@
 * Read [this wiki page](https://github.com/ocaml-sf/learn-ocaml/wiki/Checklist-for-testing-and-merging-a-PR)
 * Make sure the PR has a milestone
 * Assign yourself before merging
+* We can squash-merge 1-commit PRs (use a header with a [conventional-commit type](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md#conventional-commits-examples), add a footer with `Fix #…` if need be)