From dd17cde76b683838ef5fdba0ce66363b8b6b2d3e Mon Sep 17 00:00:00 2001 From: Cedric van Putten Date: Sun, 9 Sep 2018 01:36:10 +0200 Subject: [PATCH] chore: simplify the issue and pull request templates (#26) --- .github/ISSUE_TEMPLATE.md | 23 ------------------ .github/ISSUE_TEMPLATE/BUG_REPORT.md | 23 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 29 ++++------------------- 4 files changed, 38 insertions(+), 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 4dd8f69..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,23 +0,0 @@ - - -## Detailed description - -Provide a detailed description of the change or addition you are proposing. - -> Make it clear if the issue is a bug, an enhancement or just a question. - -## Context - -Why is this change important to you? How would you use it? How can it benefit other users? - -## Possible implementation (optional) - -Suggest an idea for implementing addition or change. - -## Your environment (bugs only) - -Include as many relevant details about the environment you experienced the bug in and how to reproduce it. - -- Node version used (e.g. Node 8, Node 10): -- Link to repo with reproduced issue -- ... diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..8cf2449 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + +### Description of the bug +How would you shortly summarise the issue? + +### To Reproduce +What steps did you perform which led to this issue? + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' + +#### Expected behavior +What did you expect to have happened? + +#### Actual behavior +What did it actually result in? + +### Additional context +Can you further explain the issue? E.g., information about version/environment or screenshots. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..81a0586 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Describe the feature you'd like** +A clear and concise description of what you want to happen. + +**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 index a0b4c33..0be134e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,26 +1,5 @@ - +### Linked issue +Provide the issue(s) which this pull request relates to or fixes. -## Description - -Describe your changes in detail. - -## Motivation and context - -Why is this change required? What problem does it solve? - -If it fixes an open issue, please link to the issue here (if you write `fixes #num` -or `closes #num` within the commit message footer, the issue will be automatically closed when the pull is accepted.) - -## Checklist: - -Go over all the following points, and put an `x` in all the boxes that apply. -Please, please, please, don't send your pull request until all of the boxes are ticked. - -- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document. -- [ ] My pull request addresses _exactly one_ patch/feature. -- [ ] I have created a _branch_ for this patch/feature. -- [ ] Each individual _commit_ in the pull request _is meaningful_. -- [ ] I have _added tests_ to cover my changes. -- [ ] If my change requires a change to the _documentation_, I have updated it accordingly. - -If you're unsure about any of these, don't hesitate to ask. We're here to help! +### Additional context +Are there things the maintainers should be aware of before merging or closing this pull request?