Skip to content

Commit

Permalink
improve issue template. (#3411)
Browse files Browse the repository at this point in the history
* improve issue template.
* add api documentation
* add MCVE guide
* enhance bug report template
* apply feedback

Signed-off-by: Outsider <outsideris@gmail.com>
  • Loading branch information
outsideris committed Feb 22, 2019
1 parent 6d3d6b4 commit 37febb6
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 5 deletions.
26 changes: 21 additions & 5 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,16 @@
---
name: Bug report
about: To report a part of mocha not working as expected
title: ''
labels: 'unconfirmed-bug'
---

<!--
Have you read Mocha's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md
For more, check out the Mocha Gitter chat room: https://gitter.im/mochajs/mocha
Detail the steps necessary to reproduce the problem. To get the fastest support, create an MCVE and upload it to GitHub.
create an [MCVE](https://stackoverflow.com/help/mcve) and upload it to GitHub.
-->

### Prerequisites
Expand All @@ -12,7 +22,7 @@ Place an `x` between the square brackets on the lines below for every satisfied
- [ ] Checked that your issue hasn't already been filed by cross-referencing [issues with the `faq` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Afaq%20)
- [ ] Checked next-gen ES issues and syntax problems by using the same environment and/or transpiler configuration without Mocha to ensure it isn't just a feature that actually isn't supported in the environment in question or a bug in your code.
- [ ] 'Smoke tested' the code to be tested by running it outside the real test suite to get a better sense of whether the problem is in the code under test, your usage of Mocha, or Mocha itself
- [ ] Ensured that there is no discrepancy between the locally and globally installed versions of Mocha. You can find them with: `node node_modules/.bin/mocha --version`(Local) and `mocha --version`(Global). We recommend avoiding the use of globally installed Mocha.
- [ ] Ensured that there is no discrepancy between the locally and globally installed versions of Mocha. You can find them with: `node node_modules/.bin/mocha --version`(Local) and `mocha --version`(Global). We recommend that you _not_ install Mocha globally.

### Description

Expand All @@ -30,6 +40,10 @@ on how to create a minimal, complete, and verifiable example.
**Expected behavior:** [What you expect to happen]

**Actual behavior:** [What actually happens]
<!--
Please include any output, especially error messages (including stacktrace). Remember, we can't see your screen.
Scrub if needed so as not to reveal passwords, etc.
-->

**Reproduces how often:** [What percentage of the time does it reproduce?]

Expand All @@ -39,11 +53,13 @@ on how to create a minimal, complete, and verifiable example.

- The output of `mocha --version` and `node node_modules/.bin/mocha --version`:
- The output of `node --version`:
- The version and architecture of your operating system:
- Your shell (bash, zsh, PowerShell, cmd, etc.):
- Your operating system
- name and version:
- architecture (32 or 64-bit):
- Your shell (e.g., bash, zsh, PowerShell, cmd):
- Your browser and version (if running browser tests):
- Any other third party Mocha related modules (with versions):
- The code transpiler being used:
- Any third-party Mocha-related modules (and their versions):
- Any code transpiler (e.g., TypeScript, CoffeeScript, Babel) being used (and its version):

### Additional Information

Expand Down
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea for Mocha
title: ''
labels: 'feature'
---

**Is your feature request related to a problem or a nice-to-have?? Please describe.**
A clear and concise description of what the problem is. E.g. 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.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/support-question.md
@@ -0,0 +1,15 @@
---
name: Support Question
about: If you have a question, please check out our Gitter or StackOverflow!
title: ''
labels: 'question'
---

<!--
We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks!.
* Website: https://mochajs.org/
* Chat room: http://gitter.im/mochajs/mocha
* StackOverflow: https://stackoverflow.com/questions/tagged/mocha using the tag `mocha`
* API documentation: https://mochajs.org/api/
-->

0 comments on commit 37febb6

Please sign in to comment.