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

Add an issue template #352

Closed
itaisteinherz opened this issue Feb 23, 2019 · 2 comments
Closed

Add an issue template #352

itaisteinherz opened this issue Feb 23, 2019 · 2 comments

Comments

@itaisteinherz
Copy link
Collaborator

We should add a template for issue to save time triaging new ones. We could add a template for PRs as well, but I'm not sure how useful that will be.

This is what I currently have in mind:

## Issue description

...

## Usage information

- [ ] Publishing to a private registry.
- [ ] Private package.
- [ ] Scoped package.

## System information

np - x.x.x
Node.js - x.x.x
npm - x.x.x
Git - x.x.x

Open to suggestions on how this can be improved to be more informative and helpful 🙃

@itaisteinherz itaisteinherz changed the title Add issue template Add an issue template Feb 23, 2019
@sindresorhus
Copy link
Owner

👍 can you do a PR with this?

@itaisteinherz
Copy link
Collaborator Author

👍 can you do a PR with this?

Sure 👌🏻

About the PR template, I think that currently one of the main problems I see is that many people create a PR which modifies np's current flow to match their own, instead of creating an issue first, so that we can help them resolve their issue instead of let them down by telling them that their PR isn't going to get merged. This is what I have in mind:

**Important: In case your PR adds new non-trivial functionality or modifies the current behavior of `np`, please create an issue first to discuss it so that it won't get dismissed and closed.**

sindresorhus added a commit that referenced this issue Mar 15, 2019
Fixes #352

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants