From 3a48c9bc2d0b032c051704696216ae1159898a23 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Tue, 15 Sep 2020 08:25:40 +0300 Subject: [PATCH] Add issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 14 +++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..86f382f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug Report +about: Report an issue with Emacs Prelude you've discovered. +--- + +*Use the template below when reporting bugs. Please, make sure that +you're running the latest Emacs Prelude 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 + +### Emacs version + +*E.g. 24.5* (use M-x emacs-version to check it if unsure) + +### Operating system + +*E.g. Fedora 23, OS X 10.11 "El Capitan", Windows 10, etc* diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..7c791b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: Suggest new Emacs Prelude features or improvements to existing features. +--- + +**Is your feature request related to a problem? Please describe.** + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** + +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** + +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** + +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..30352f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +**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](../blob/master/CONTRIBUTING.md) +- [ ] You've added tests (if possible) to cover your change(s) +- [ ] You've updated the [changelog](../blob/master/CHANGELOG.md) (if adding/changing user-visible functionality) +- [ ] You've updated the [user manual](../blob/master/doc) (if adding/changing user-visible functionality) + +Thanks!