From 58b3cff7f657536773e078cf5e177592fd33b1d1 Mon Sep 17 00:00:00 2001 From: Kunal Nagpal Date: Fri, 9 Jun 2017 00:34:17 +0530 Subject: [PATCH 1/3] docs(meta): Added issue, pull request templates. :scroll: [ci skip] --- .github/ISSUE_TEMPLATE.md | 40 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 32 +++++++++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..6b103ea0e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,40 @@ + + +### Prerequisites + +* [ ] Checked that your issue isn't already filed by cross referencing [issues with the `common mistake` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Acommon-mistake%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 the user's 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, the user's usage of Mocha, or Mocha itself + +### 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 + + +### Additional Information + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..fb10d2a98b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +### Requirements + +* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. +* All new code requires tests to ensure against regressions + +### Description of the Change + + + +### Alternate Designs + + + +### Why Should This Be In Core? + + + +### Benefits + + + +### Possible Drawbacks + + + +### Applicable Issues + + From 1d2da879e6db8502947c3f8903c1045104a7bc86 Mon Sep 17 00:00:00 2001 From: Kunal Nagpal Date: Fri, 9 Jun 2017 23:49:50 +0530 Subject: [PATCH 2/3] Addressed PR#2869 comments [ci skip] --- .github/ISSUE_TEMPLATE.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 6b103ea0e1..7085cfc263 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,8 +8,10 @@ For more, check out the Mocha gitter space: https://gitter.im/mochajs/mocha Place an `x` between the square brackets on the lines below for every satisified prerequisite. --> * [ ] Checked that your issue isn't already filed by cross referencing [issues with the `common mistake` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Acommon-mistake%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 the user's 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, the user's usage of Mocha, or Mocha itself +* [ ] 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/mocha/bin/mocha* --version`(Local) and `mocha -v`(Global). We recommend avoiding the use of globally installed Mocha. ### Description ### Additional Information From 0afcde5e722d966ee08d4a0423115688e07c47cf Mon Sep 17 00:00:00 2001 From: Kunal Nagpal Date: Thu, 15 Jun 2017 23:07:41 +0530 Subject: [PATCH 3/3] Addressed some more comments on PR#2869 [skip ci] --- .github/ISSUE_TEMPLATE.md | 18 +++++++++++------- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++------ 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 7085cfc263..8d7e7d1baa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,17 +1,17 @@ ### Prerequisites -* [ ] Checked that your issue isn't already filed by cross referencing [issues with the `common mistake` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Acommon-mistake%20) +* [ ] Checked that your issue isn't already filed by cross referencing [issues with the `common mistake` label](https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Acommon-mistake%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/mocha/bin/mocha* --version`(Local) and `mocha -v`(Global). We recommend avoiding the use of globally installed Mocha. +`node node_modules/.bin/mocha --version`(Local) and `mocha --version`(Global). We recommend avoiding the use of globally installed Mocha. ### Description ### Additional Information diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fb10d2a98b..0252085436 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,13 @@ ### Requirements * Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. -* All new code requires tests to ensure against regressions +* All new code requires tests to ensure against regressions. ### Description of the Change @@ -15,9 +15,9 @@ We must be able to understand the design of your change from this description. I -### Why Should This Be In Core? +### Why should this be in core? - + ### Benefits @@ -27,6 +27,14 @@ We must be able to understand the design of your change from this description. I -### Applicable Issues +### Applicable issues - +