Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: Add issue and pull request templates #2851

Closed
kunagpal opened this issue May 31, 2017 · 3 comments
Closed

Suggestion: Add issue and pull request templates #2851

kunagpal opened this issue May 31, 2017 · 3 comments
Labels
area: documentation anything involving docs or mochajs.org area: repository tooling concerning ease of contribution type: chore generally involving deps, tooling, configuration, etc.

Comments

@kunagpal
Copy link
Contributor

Sample reference:
https://github.com/atom/atom/blob/master/PULL_REQUEST_TEMPLATE.md
https://github.com/atom/atom/blob/master/ISSUE_TEMPLATE.md

@ScottFreeCode
Copy link
Contributor

Considering how often I link people to https://stackoverflow.com/help/mcve we might want to recommend it in the issue template. It might be less annoying to read it beforehand than to read it coming from me as the main response to an issue, heh heh.

We might also look at suggesting things to double-check for common issues, e.g.:

  • next-gen ES issues and syntax problems should be checked against 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
  • similarly but more generally, "smoke-testing" the user 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 the test library, or the test library itself

@ScottFreeCode ScottFreeCode added type: chore generally involving deps, tooling, configuration, etc. area: documentation anything involving docs or mochajs.org labels Jun 2, 2017
@ScottFreeCode
Copy link
Contributor

One thing I see in those templates that I haven't seen elsewhere but I particularly like is "Reproduces how often" -- it's great to acknowledge that some issues really are intermittent, and to give the maintainers a heads-up on whether it's possible the issue won't appear for them immediately when they try it so that doesn't just seem like something wrong on the user's end. (Of course, inconsistent reproduction is one of those things that goes down with a good, thorough MCVE, which is why I keep linking that too. But these are complementary measures.)

@ScottFreeCode
Copy link
Contributor

We could put a link in the issue template to a search for issues with the "common mistake" tag too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org area: repository tooling concerning ease of contribution type: chore generally involving deps, tooling, configuration, etc.
Projects
None yet
Development

No branches or pull requests

2 participants