Skip to content

Commit

Permalink
update contributing doc (#22874)
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcy Sutton authored Apr 7, 2020
1 parent 30397f3 commit c16eaa2
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions docs/contributing/how-to-file-an-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@
title: How to File an Issue
---

The [issue tracker](https://github.com/gatsbyjs/gatsby/issues) is the preferred channel for bug reports, feature requests and [submitting pull requests](/contributing/how-to-open-a-pull-request/).
The Gatsby GitHub [issue tracker](https://github.com/gatsbyjs/gatsby/issues) is the preferred channel for bug reports, documentation, feature requests and [submitting pull requests](/contributing/how-to-open-a-pull-request/).

If you want your issue to be resolved quickly, please include in your issue:
To resolve your issue, please select the appropriate category:

- Bug Reports
- Documentation
- Feature Requests
- New [Translation](/contributing/translation#creating-a-new-translation) Requests

For bug reports, include in your issue:

- Gatsby version, Node.js version, OS version
- The contents of your `gatsby-config.js` and `package.json` as well as your
`gatsby-node.js`, `gatsby-browser.js` `gatsby-ssr.js` files depending on
changes you've made there.
- A [reproduction](/contributing/how-to-make-a-reproducible-test-case/) for debugging and taking action

Please do not use the issue tracker for personal support requests. [Stack Overflow](https://stackoverflow.com/questions/ask?tags=gatsby) (**gatsby** tag) and the [Gatsby Discord](https://gatsby.dev/discord) are better places to get help.

Expand All @@ -18,7 +26,7 @@ Please do not use the issue tracker for personal support requests. [Stack Overfl
If an issue is affecting you, start at the top of this list and complete as many tasks on the list as you can:

1. If there is an issue, add a reaction or more details to the issue to indicate that it's affecting you
2. If there is an issue and you can add more detail, write a comment describing how the bug is affecting you, OR if you can, write up a work-around for the bug
3. If there _is not_ an issue, write the most complete description of what's happening, preferably with a link to a Gatsby site that reproduces the problem or [create a reproducible test case](/contributing/how-to-make-a-reproducible-test-case/)
4. Offer to help fix the bug (and it is totally expected that you ask for help; open-source maintainers want to help contributors)
2. If there is an issue and you can add more detail, write a comment describing how the problem is affecting you, OR if you can, write up a work-around or improvement for the issue
3. If there _is not_ an issue, write the most complete description of what's happening, preferably with a link to a Gatsby site that reproduces the problem or [create a reproducible test case](/contributing/how-to-make-a-reproducible-test-case/) where applicable
4. Offer to help fix the issue (and it is totally expected that you ask for help; open-source maintainers want to help contributors)
5. [Deliver a well-crafted, tested PR](/contributing/how-to-open-a-pull-request/)

0 comments on commit c16eaa2

Please sign in to comment.