aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-03-22 08:29:54 +0200
committerBozhidar Batsov <bozhidar@batsov.com>2016-03-22 08:29:54 +0200
commit63d4f3f255b368fd16f688803a1c1e34e77dd5de (patch)
treeca97727fbe1e1598bd510c2b47c7e43d9aa42e34 /.github
parentf8392cb3e090e3023cffbf82ae55d87858dd4cb1 (diff)
Add an issue and a PR template
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md33
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md11
2 files changed, 44 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..51d55fa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,33 @@
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable Projectile and that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+**Remove all of the placeholder text in your final report!**
+
+## 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
+
+### Projectile version information
+
+*Include here the version string displayed by `M-x
+projectile-version`. Here's an example:*
+
+```
+Projectile version: 0.13
+```
+
+### Emacs version
+
+*E.g. 24.5* (use <kbd>C-h C-a</kbd> to see it)
+
+### 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 0000000..0f3b0e6
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
+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)
+- [ ] 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)
+
+Thanks!