branch: elpa/inf-clojure commit e6a4ef39d65e796a7b29fa8676d4bb12e192ad42 Author: Bozhidar Batsov <bozhi...@batsov.com> Commit: Bozhidar Batsov <bozhi...@batsov.com>
Add some handy GitHub templates to improve the contribution process --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .github/ISSUE_TEMPLATE.md | 36 ++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++++ 3 files changed, 52 insertions(+) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..d94fe43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,36 @@ +*Use the template below when reporting bugs. Please, make sure that +you're running the latest stable inf-clojure and that the problem you're reporting +hasn't been reported (and potentially fixed) already.* + +*When requesting new features or improvements to existing features you can +discard the template completely. Just make sure to make a good case for your +request.* + +**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 + +### inf-clojure version information + +*E.g. 1.4.0* + +### Lein/Boot version + +*E.g. Lein 2.6.1* (skip this when you didn't use Lein or Boot to start a REPL) + +### Emacs version + +*E.g. 24.5* (use <kbd>M-x emacs-version</kbd> to check it if unsure) + +### Operating system + +*E.g. Fedora 23, OS X 10.11 "El Capitan", Windows 10, etc* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b76964a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +**Replace this placeholder text with a summary of the changes in your PR. +The more detailed you are, the better.** + +----------------- + +Before submitting the 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][1] +- [ ] 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! + +[1]: https://github.com/clojure-emacs/inf-clojure/blob/master/.github/CONTRIBUTING.md