Browse Source

Clarify templates

- what to chose and do
- remove checkboxs
- all question in comments
- reformat style
master
Futago-za Ryuu 3 years ago
parent
commit
43a305eaef
2 changed files with 54 additions and 43 deletions
  1. +34
    -34
      .github/ISSUE_TEMPLATE.md
  2. +20
    -9
      .github/PULL_REQUEST_TEMPLATE.md

+ 34
- 34
.github/ISSUE_TEMPLATE.md View File

@ -1,54 +1,54 @@
<!---
If a section does not apply, you are free to remove it.
For example, when you select "Not an issue", you can remove all sections apart
from the "Issue type" section
-->
### Issue type
* [ ] Bug Report
* [ ] Feature Request
* [ ] Question
* [ ] Not an issue
<!-- What type of issue is this (choose _yes_ or _no_): -->
- **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)?
<!-- Have you done the following (choose _yes_ or _no_): -->
- **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.
<!-- For more information, see the CONTRIBUTING document. -->
### Description
[Description of the bug or feature]
<!-- A description of the bug, feature or question -->
### Steps to Reproduce
1. [First Step]
2. [Second Step]
3. [and so on...]
1. <!-- First Step -->
2. <!-- Second Step -->
3. <!-- and so on... -->
**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:**
<!-- What you expected to happen -->
**Actual behavior:**
<!-- What actually happened -->
**Actual behavior:** [What actually happened]
### Software
### System
<!-- Having more details about your software might help pinpoint the source of a bug: -->
**PEG.js:** ...
**Node.js:** ...
**NPM:** ...
**Browser:** ...
**OS:** ...
**Editor:** ...
- **PEG.js:**
- **Node.js:**
- **NPM or Yarn:**
- **Browser:**
- **OS:**
- **Editor:**

+ 20
- 9
.github/PULL_REQUEST_TEMPLATE.md View File

@ -1,9 +1,20 @@
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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
<!--- What types of changes does your code introduce? (choose _yes_ or _no_): -->
- **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
<!-- Have you done the following (choose _yes_ or _no_): -->
- **I have read the [CONTRIBUTING.md](CONTRIBUTING.md) document:**
- **I have updated the documentation accordingly:**
- **I have added tests to cover my changes:**
### Description
<!-- A description of the PR and commits included -->

Loading…
Cancel
Save