summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-02-25 08:59:20 +0200
committerBozhidar Batsov <bozhidar@batsov.com>2016-02-25 08:59:20 +0200
commit4dfd3ed8265fa9d9c04afc53bd23f1f01329592f (patch)
tree6a73c2e5840978e25a6cc44f6efdf83c32a67c03 /.github
parent196a557789fe8475508ff8fbd1cffe5723ccb482 (diff)
[Fix #1576] Add issue and PR templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md31
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md11
2 files changed, 42 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..70080374
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,31 @@
+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.
+
+## Expected behavior
+
+## Actual behavior
+
+## Steps to reproduce the problem
+
+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:
+
+```
+; CIDER 0.11.0snapshot (package: 20151112.1551) (Clojure 1.7.0, nREPL 0.2.12)
+```
+
+### Emacs version
+
+E.g. 24.5
+
+### Operating system
+
+E.g. Windows 10
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..6d06ad35
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+Before submitting a PR make sure the following things have been done:
+
+-[]The commits are consistent with our contribution guidelines
+-[]You've added tests (if possible) to cover your change(s)
+-[]All tests are passing (`make test`)
+-[]The new code is not generating bytecode or `M-x checkdoc` warnings
+-[]You've updated the changelog (if adding/changing user-visible functionality)
+-[]You've updated the readme (if adding/changing user-visible functionality)
+-[]You've updated the refcard (if you made changes to the commands listed there)
+
+Thanks!