diff options
author | Jonas Zohren | 2020-11-12 19:38:14 +0100 |
---|---|---|
committer | David Mehren | 2020-11-16 11:54:38 +0100 |
commit | d3eb8e70f8df86b94461bf3491460ec05f84f552 (patch) | |
tree | 72f9c72c2c78d79ddde21bb2b8f909cfc3e33a60 | |
parent | 4c0efe1237bc33b52d06eaf86a28adad9a041ec2 (diff) |
Add templates for issues and PRs
Signed-off-by: Jonas Zohren <15788906+jfowl@users.noreply.github.com>
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 40 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/enhancement_request.md | 29 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 27 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/question---other.md | 16 | ||||
-rw-r--r-- | .github/pull_request_template.md | 17 |
5 files changed, 129 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..13070148 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +<!-- If you're requesting an improvement for an existing feature, then please consider filling out an "enhancement request" instead! --> +<!-- If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! --> + +**Description** +<!-- A clear and concise description of what the bug is. --> + +**To Reproduce** +<!-- Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error --> + +**Expected behavior** +<!-- A clear and concise description of what you expected to happen. --> + +**Logs** +<!-- If applicable, add an excerpt from the server logs where the error is reported. Remember to censor sensitive values. --> + +**Config** +<!-- If applicable, copy and paste your config (or ideally only relevant parts of it) here. Remember to censor sensitive values. --> + +**Your Setup (please complete the following information):** + - Host OS: [e.g. Ubuntu 20.04] + - NodeJS version [run `node --version`] + - HedgeDoc version (Click "Version info" in the footer) + - server [e.g. 2.0] + - client [e.g. 2.0] + +**Additional context** +<!-- Add any other context about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md new file mode 100644 index 00000000..3d7af927 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -0,0 +1,29 @@ +--- +name: Enhancement request +about: Suggest an enhancement of an existing feature. +title: '' +labels: 'enhancement' +assignees: '' + +--- + +<!-- If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! --> +<!-- If you want to report a bug or an error, then please consider filling out a "bug report" instead! --> + +**Which part of the project should be enhanced?** +<!-- A clean and concise description of which part should be modified. --> + +**Is your enhancement 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 and why. +--> + +**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/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..092a42c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest a new feature for this project, which isn't existing yet. +title: '' +labels: 'feature' +assignees: '' + +--- + +<!-- If you're requesting an improvement for an existing feature, then please consider filling out an "enhancement request" instead! --> +<!-- If you want to report a bug or an error, then please consider filling out a "bug report" instead! --> + + +**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/ISSUE_TEMPLATE/question---other.md b/.github/ISSUE_TEMPLATE/question---other.md new file mode 100644 index 00000000..db6c0391 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question---other.md @@ -0,0 +1,16 @@ +--- +name: Question / Other +about: Questions about the project, features, or organziational issues +title: '' +labels: question +assignees: '' + +--- + +<!-- If you're requesting an improvement for an existing feature, then please consider filling out an "enhancement request" instead! --> +<!-- If you're requesting a new feature, that isn't part of this project yet, then please consider filling out a "feature request" instead! --> +<!-- If you want to report a bug or an error, then please consider filling out a "bug report" instead! --> + +**What is your question?** + +<!-- Please be precise and make it possible to understand your question. --> diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..fbc61e54 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +### Component/Part +<!-- e.g database --> + +### Description +This PR fixes/adds/improves/... + +### Steps + +<!-- please tick steps this PR performs (if something is not necessary, please tick anyway to indicate you considered it) --> + +- [ ] added implementation +- [ ] added / updated tests +- [ ] added / updated documentation +- [ ] extended changelog + +### Related Issue(s) +<!-- e.g #123 --> |