From 43a305eaef4971353b850003502d64dbf5effac4 Mon Sep 17 00:00:00 2001 From: Futago-za Ryuu Date: Sat, 3 Feb 2018 16:46:16 +0000 Subject: [PATCH] Clarify templates - what to chose and do - remove checkboxs - all question in comments - reformat style --- .github/ISSUE_TEMPLATE.md | 68 ++++++++++++++++---------------- .github/PULL_REQUEST_TEMPLATE.md | 29 +++++++++----- 2 files changed, 54 insertions(+), 43 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 19b459f..a8d07e1 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,54 +1,54 @@ - - ### Issue type -* [ ] Bug Report -* [ ] Feature Request -* [ ] Question -* [ ] Not an issue + + +- **Bug Report:** +- **Feature Request:** +- **Question:** +- **Not an issue:** ### Prerequisites -* [ ] Can you reproduce the issue? -* [ ] Is this an urgent issue? -* [ ] Did you search the repository issues? -* [ ] Did you check the forums? -* [ ] Did you perform a web search (google, yahoo, etc)? + + +- **Can you reproduce the issue?:** +- **Did you search the repository issues?:** +- **Did you check the forums?:** +- **Did you perform a web search (google, yahoo, etc)?:** -For more information, see the **CONTRIBUTING** document. + ### Description -[Description of the bug or feature] + ### Steps to Reproduce -1. [First Step] -2. [Second Step] -3. [and so on...] +1. +2. +3. **Example code:** +```js + // An example of code related to this issue ``` - An example of code related to this issue -``` -**Expected behavior:** [What you expected to happen] +**Expected behavior:** + + + +**Actual behavior:** + + -**Actual behavior:** [What actually happened] +### Software -### System + -**PEG.js:** ... -**Node.js:** ... -**NPM:** ... -**Browser:** ... -**OS:** ... -**Editor:** ... +- **PEG.js:** +- **Node.js:** +- **NPM or Yarn:** +- **Browser:** +- **OS:** +- **Editor:** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0ca610a..38f4746 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,20 @@ -## Types of changes - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to change) -- [ ] I have read the **CONTRIBUTING** document. -- [ ] My change requires a change to the documentation. -- [ ] I have updated the documentation accordingly. -- [ ] I have added tests to cover my changes. +### PR type + + + +- **Bug fix (non-breaking change which fixes an issue):** +- **New feature (non-breaking change which adds functionality):** +- **Breaking change (fix or feature that would cause existing functionality to change):** +- **Documentation change:** + +### Prerequisites + + + +- **I have read the [CONTRIBUTING.md](CONTRIBUTING.md) document:** +- **I have updated the documentation accordingly:** +- **I have added tests to cover my changes:** + +### Description + +