summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-03-22 08:16:00 +0200
committerBozhidar Batsov <bozhidar@batsov.com>2016-03-22 08:16:00 +0200
commitffde106429fcfab5d59981f9ccc86410580aeff2 (patch)
treeb6c8ad4000681dcf4ab08fb4ee3b512dc713332f /.github
parent6bf2d1d79115f5bac746f2e08533e9133a6b3ddc (diff)
Improve a bit the PR and issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md18
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md3
2 files changed, 12 insertions, 9 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 70080374..1557a2e7 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,6 +1,8 @@
-Use the template below when reporting bugs. Please, make sure that
+*Use the template below when reporting bugs. Please, make sure that
you're running the latest stable CIDER and that the problem you're reporting
-hasn't been reported (and potentially fixed) already.
+hasn't been reported (and potentially fixed) already.*
+
+**Remove all of the placeholder text in your final report!**
## Expected behavior
@@ -8,15 +10,15 @@ hasn't been reported (and potentially fixed) already.
## Steps to reproduce the problem
-This is extremely important! Providing us with a reliable way to reproduce
-a problem will expedite its solution.
+*This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.*
## Environment & Version information
### CIDER version information
-Include here the version string displayed when
-CIDER's REPL is launched. Here's an example:
+*Include here the version string displayed when
+CIDER's REPL is launched. Here's an example:*
```
; CIDER 0.11.0snapshot (package: 20151112.1551) (Clojure 1.7.0, nREPL 0.2.12)
@@ -24,8 +26,8 @@ CIDER's REPL is launched. Here's an example:
### Emacs version
-E.g. 24.5
+*E.g. 24.5*
### Operating system
-E.g. Windows 10
+*E.g. Windows 10*
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3081e957..e6221a66 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,5 @@
-Before submitting a PR make sure the following things have been done:
+Before submitting a PR make sure the following things have been done (and denote this
+by checking the relevant checkboxes):
- [ ] The commits are consistent with our [contribution guidelines](CONTRIBUTING.md)
- [ ] You've added tests (if possible) to cover your change(s)