Skip to content

Commit 37febb6

Browse files
authored
improve issue template. (#3411)
* improve issue template. * add api documentation * add MCVE guide * enhance bug report template * apply feedback Signed-off-by: Outsider <outsideris@gmail.com>
1 parent 6d3d6b4 commit 37febb6

File tree

3 files changed

+54
-5
lines changed

3 files changed

+54
-5
lines changed

.github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/bug_report.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1+
---
2+
name: Bug report
3+
about: To report a part of mocha not working as expected
4+
title: ''
5+
labels: 'unconfirmed-bug'
6+
---
7+
18
<!--
29
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
310
For more, check out the Mocha Gitter chat room: https://gitter.im/mochajs/mocha
11+
12+
Detail the steps necessary to reproduce the problem. To get the fastest support, create an MCVE and upload it to GitHub.
13+
create an [MCVE](https://stackoverflow.com/help/mcve) and upload it to GitHub.
414
-->
515

616
### Prerequisites
@@ -12,7 +22,7 @@ Place an `x` between the square brackets on the lines below for every satisfied
1222
- [ ] 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)
1323
- [ ] 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.
1424
- [ ] '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
15-
- [ ] 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.
25+
- [ ] 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.
1626

1727
### Description
1828

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

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

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

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

4054
- The output of `mocha --version` and `node node_modules/.bin/mocha --version`:
4155
- The output of `node --version`:
42-
- The version and architecture of your operating system:
43-
- Your shell (bash, zsh, PowerShell, cmd, etc.):
56+
- Your operating system
57+
- name and version:
58+
- architecture (32 or 64-bit):
59+
- Your shell (e.g., bash, zsh, PowerShell, cmd):
4460
- Your browser and version (if running browser tests):
45-
- Any other third party Mocha related modules (with versions):
46-
- The code transpiler being used:
61+
- Any third-party Mocha-related modules (and their versions):
62+
- Any code transpiler (e.g., TypeScript, CoffeeScript, Babel) being used (and its version):
4763

4864
### Additional Information
4965

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for Mocha
4+
title: ''
5+
labels: 'feature'
6+
---
7+
8+
**Is your feature request related to a problem or a nice-to-have?? Please describe.**
9+
A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
10+
11+
**Describe the solution you'd like**
12+
A clear and concise description of what you want to happen.
13+
14+
**Describe alternatives you've considered**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Support Question
3+
about: If you have a question, please check out our Gitter or StackOverflow!
4+
title: ''
5+
labels: 'question'
6+
---
7+
8+
<!--
9+
We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks!.
10+
11+
* Website: https://mochajs.org/
12+
* Chat room: http://gitter.im/mochajs/mocha
13+
* StackOverflow: https://stackoverflow.com/questions/tagged/mocha using the tag `mocha`
14+
* API documentation: https://mochajs.org/api/
15+
-->

0 commit comments

Comments
 (0)