From f91d7ea5275f406fdfe2075f4b1ee37df9f8aaf0 Mon Sep 17 00:00:00 2001 From: "JeongHoon Byun (aka Outsider)" Date: Thu, 7 Jun 2018 12:59:51 +0900 Subject: [PATCH] improve issue template. --- .github/ISSUE_TEMPLATE/bug_report.md | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++ .github/ISSUE_TEMPLATE/support-question.md | 11 ++++ 3 files changed, 86 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/support-question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..55c801675c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,58 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + + + +### Prerequisites + + + +- [ ] 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. + +### Description + + + +### Steps to Reproduce + + + +**Expected behavior:** [What you expect to happen] + +**Actual behavior:** [What actually happens] + +**Reproduces how often:** [What percentage of the time does it reproduce?] + +### Versions + + + +- 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 browser and version (if running browser tests): +- Any other third party Mocha related modules (with versions): +- The code transpiler being used: + +### Additional Information + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..c763ca6cf0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for Mocha + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. 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. diff --git a/.github/ISSUE_TEMPLATE/support-question.md b/.github/ISSUE_TEMPLATE/support-question.md new file mode 100644 index 0000000000..e40d9fc3d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support-question.md @@ -0,0 +1,11 @@ +--- +name: Support Question +about: If you have a question, please check out our Gitter or StackOverflow! + +--- + +--------------^ Click "Preview" for a nicer view! +We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks!. + +* Chat room: http://gitter.im/mochajs/mocha +* StackOverflow: https://stackoverflow.com/questions/tagged/mocha using the tag `mocha`