From 60c2d25d6f2de7ae1dd1086028853bfb4181b229 Mon Sep 17 00:00:00 2001 From: Florian Kissling Date: Fri, 9 Feb 2018 15:15:04 +0100 Subject: [PATCH] =?UTF-8?q?[www]=20Add=20dedicated=20=E2=80=9EHow=20to=20F?= =?UTF-8?q?ile=20an=20Issue=E2=80=9C=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * move „Filing an Issue“ and „Special Note on Issues“ from the „How to Contribute“ to the new „How to File an Issue“ page * add an intro paragraph to the new page linking to the GitHub Gatsby issue tracker * add a paragraph to the new page informing about personal support requests, pointing to Stack Overflow, Reactiflux Discord * add link to the new page to * the docs sidebar’s „Contributing“ section * the GitHub issue template * the „Community“ page * the list of ways to contribute on the „How to Contribute“ page * link „Triaging GitHub issues“ on the „How to Contribute“ page --- .github/ISSUE_TEMPLATE.md | 1 + CONTRIBUTING.md | 22 ++-------------------- docs/community/index.md | 6 +++--- docs/docs/how-to-file-an-issue.md | 24 ++++++++++++++++++++++++ www/src/pages/docs/doc-links.yaml | 2 ++ 5 files changed, 32 insertions(+), 23 deletions(-) create mode 100644 docs/docs/how-to-file-an-issue.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index e6bb7c9006d04..9bef255173e42 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,6 +6,7 @@ Useful Links: - Documentation: https://www.gatsbyjs.org/docs/ - How to Contribute: https://www.gatsbyjs.org/docs/how-to-contribute/ + - How to File an Issue: https://www.gatsbyjs.org/docs/how-to-file-an-issue/ - Become a Sponsor: https://opencollective.com/gatsby#sponsor Before opening a new issue, please search existing issues (https://github.com/gatsbyjs/gatsby/issues) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15d59d1ed1af2..f8972c3f5f0ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,6 @@ title: How to contribute --- -## Filing an issue - -If you want your issue to be resolved quickly, please 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. - ## Contributing We want contributing to Gatsby to be fun, enjoyable, and educational for anyone and everyone. Contributions go far beyond pull requests and commits; we are thrilled to receive a variety of other contributions including the following: @@ -21,7 +12,8 @@ We want contributing to Gatsby to be fun, enjoyable, and educational for anyone * Submitting documentation updates, enhancements, designs, or bugfixes * Submitting spelling or grammar fixes * Adding unit or functional tests -* Triaging GitHub issues -- especially determining whether an issue still persists or is reproducible +* Triaging [GitHub issues](https://github.com/gatsbyjs/gatsby/issues) -- especially determining whether an issue still persists or is reproducible +* [Reporting bugs or issues](/docs/how-to-file-an-issue/) * Searching for Gatsby on Discord or Spectrum and helping someone else who needs help * Teaching others how to contribute to Gatsby's repo! @@ -29,16 +21,6 @@ If you are worried or don't know where to start, you can always reach out to Sha Looking to speak about Gatsby? We'd love to review your talk abstract/CFP! You can email it to shannon [at] gatsbyjs [dot] com and we can give pointers or tips!!! -### Special Note on Issues - -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, +1 the issue to indicate that it's affecting you -2. If there's an issue and you can add more detail, write a comment describing how the bug is affecting OR if you can, write up a work-around for the bug -3. If there's not an issue, write the most complete description of what's happening, preferably with link to a Gatsby site that reproduces the problem -4. Offer to help fix the bug (and it's totally expected that you ask for help; open-source maintainers want to help contributors) -5. Deliver a well-crafted, tested PR - ### Creating your own plugins and loaders If you create a loader or plugin, we would <3 for you to open source it, and put it on npm. diff --git a/docs/community/index.md b/docs/community/index.md index 33a9fb8ab37cf..51ed45249c47a 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -17,9 +17,9 @@ and orientation. The Gatsby community welcomes contributions. Please refer to the guides below on how to make sure your contributions get accepted: -[How to Contribute](/docs/how-to-contribute/) - -[Gatsby Style Guide](/docs/gatsby-style-guide/) +* [How to Contribute](/docs/how-to-contribute/) +* [How to File an Issue](/docs/how-to-file-an-issue/) +* [Gatsby Style Guide](/docs/gatsby-style-guide/) ## Gatsby news diff --git a/docs/docs/how-to-file-an-issue.md b/docs/docs/how-to-file-an-issue.md new file mode 100644 index 0000000000000..e395c3d6a0a75 --- /dev/null +++ b/docs/docs/how-to-file-an-issue.md @@ -0,0 +1,24 @@ +--- +title: How to file an issue +--- + +The [issue tracker](https://github.com/gatsbyjs/gatsby/issues) is the preferred channel for bug reports, features requests and submitting pull requests. + +If you want your issue to be resolved quickly, please 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. + +Please do not use the issue tracker for personal support requests. [Stack Overflow](http://stackoverflow.com/questions/ask?tags=gatsby) (**gatsby** tag) and the [Reactiflux Discord](https://discord.gg/0ZcbPKXt5bZjGY5n) #gatsby channels are better places to get help. + +### Special Note on Issues + +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, +1 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 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 link to a Gatsby site that reproduces the problem +4. Offer to help fix the bug (and it is totally expected that you ask for help; open-source maintainers want to help contributors) +5. Deliver a well-crafted, tested PR diff --git a/www/src/pages/docs/doc-links.yaml b/www/src/pages/docs/doc-links.yaml index 5223e1f58dec0..ff8e79ba0b8fe 100644 --- a/www/src/pages/docs/doc-links.yaml +++ b/www/src/pages/docs/doc-links.yaml @@ -92,6 +92,8 @@ items: - title: How to Contribute link: /docs/how-to-contribute/ + - title: How to File an Issue + link: /docs/how-to-file-an-issue/ - title: Gatsby Style Guide link: /docs/gatsby-style-guide/ - title: Design Principles*