Added issue, pull request templates. #2869
Conversation
There was a problem hiding this comment.
Thanks! This looks like a good start; just a few small things that I think should be tightened up here:
- Change references to "the user('s)" to "you(r)".
- The Version section isn't particularly reliable without first addressing the possibility that there's a discrepancy between global and local versions of Mocha; something about that (perhaps just a blanket recommendation to uninstall global Mocha?) should go in the prerequisites section I suppose?
- May as well throw in Node version in the Versions section on top of Mocha version and OS version.
|
@ScottFreeCode Ping |
.github/ISSUE_TEMPLATE.md
Outdated
| * [ ] 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. |
There was a problem hiding this comment.
"node node_modules/mocha/bin/mocha*" -> "node_modules/.bin/mocha" or at least remove the "*".
"mocha -v" -> "mocha --version"
.github/ISSUE_TEMPLATE.md
Outdated
| <!-- | ||
| You can get this information from copy and pasting the output of `mocha --version` from the command line. | ||
| Also, please include the following: | ||
| * The version and architecture of the operation system being used. |
There was a problem hiding this comment.
"operation system" -> "operating system"
There was a problem hiding this comment.
I'd like to see something like this:
If applicable, please specify:
- The output of
mocha --version:- The output of
node --version:- Your OS:
- Your shell (
bash,zsh, PowerShell,cmd, etc):- Your browser and version:
- Any third-party Mocha-related modules:
.github/ISSUE_TEMPLATE.md
Outdated
| @@ -0,0 +1,45 @@ | |||
| <!-- | |||
| 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 space: https://gitter.im/mochajs/mocha | |||
There was a problem hiding this comment.
how about instead of "gitter space" "Gitter chat room", since not everyone knows what Gitter is?
.github/ISSUE_TEMPLATE.md
Outdated
| 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 your code. |
There was a problem hiding this comment.
I think this can be woven into the point below by mentioning transpiled code and environment
.github/ISSUE_TEMPLATE.md
Outdated
| <!-- | ||
| You can get this information from copy and pasting the output of `mocha --version` from the command line. | ||
| Also, please include the following: | ||
| * The version and architecture of the operation system being used. |
There was a problem hiding this comment.
I'd like to see something like this:
If applicable, please specify:
- The output of
mocha --version:- The output of
node --version:- Your OS:
- Your shell (
bash,zsh, PowerShell,cmd, etc):- Your browser and version:
- Any third-party Mocha-related modules:
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ### 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 |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| <!-- Explain what other alternates were considered and why the proposed version was selected --> | ||
|
|
||
| ### Why Should This Be In Core? |
There was a problem hiding this comment.
inconsistent capitalization
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| <!-- | ||
|
|
||
| We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts. |
There was a problem hiding this comment.
We must be able to understand the design of your change from this description. Keep in mind that the maintainers and/or community members reviewing this PR may not be familiar with the subsystem. Please be verbose.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| ### Why Should This Be In Core? | ||
|
|
||
| <!-- Explain why this functionality should be in mocha as opposed to a package --> |
There was a problem hiding this comment.
"as opposed to its own package"
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| ### Applicable Issues | ||
|
|
||
| <!-- Enter any applicable Issues here --> |
There was a problem hiding this comment.
Please add something like:
Mocha follows semantic versioning: http://semver.org
Is this a breaking change (major release)? Is it an enhancement (minor release)? Is it a bug
fix, or does it not impact production code (patch release)?
boneskull
added
the
semver-patch
|
I don't know if I mentioned it before, but I really appreciate how the common-mistake label link brings up both open and closed issues. 👍 |
|
@ScottFreeCode Ping |
|
@boneskull Did you get a chance to check that your requests were addressed to your satisfaction? Is there still anything that's incorrect or missing, or otherwise might prevent users and contributors from getting us what we need simply by following the template (as opposed to minor cleanup, such as non-code typographical corrections, that we can address later)? |
|
wfm, thanks! |
* docs(meta): Added issue, pull request templates. 📜 [ci skip] * Addressed PR#2869 comments [ci skip] * Addressed some more comments on PR#2869 [skip ci]
Resolves #2851