Gatsby: [www] Consider consolidating "Filing an issue" and "Special Note on Issues"

Created on 8 Feb 2018  Â·  5Comments  Â·  Source: gatsbyjs/gatsby

Worked on #3750 earlier today and wondered why the two sections above are "interrupted" by the "Contributing" section.

I find both "Filing an Issue" and "Special note on Issues" equally important and would like to suggest consolidating the two sections. Also it would allow us to link to one place instead of two in the starter CONTRIBUTING.md (first horrible draft here https://github.com/gatsbyjs/gatsby-starter-default/pull/44).

I also feel https://www.gatsbyjs.org/docs/how-to-contribute/#contributing would do a great job at acting as the introduction to https://www.gatsbyjs.org/docs/how-to-contribute/.

What do you think? Am I missing the obvious?

/cc @shannonbux

documentation

Most helpful comment

I 🤒 don't :sneezing_face: fully understand _how_ but 😻!

All 5 comments

Those all sound like great ideas. These docs have evolved without planning
an overall vision. They need to be organized better! Please feel free to
organize them how you think is best!

I also think the section
https://www.gatsbyjs.org/docs/gatsby-style-guide/#how-to-contribute is
possibly inaccurate and redundant considering the How to Contribute page.
Should we just remove the how to contribute section from the style guide?

On Thu, Feb 8, 2018 at 9:52 AM, Florian Kissling notifications@github.com
wrote:

>

Worked on #3750 https://github.com/gatsbyjs/gatsby/issues/3750 earlier
today and wondered why the two sections above are "interrupted" by the "
Contributing
https://www.gatsbyjs.org/docs/how-to-contribute/#contributing" section.
You can see my first draft for a CONTRIBUTING.md at
gatsbyjs/gatsby-starter-default#44
https://github.com/gatsbyjs/gatsby-starter-default/pull/44.

I find both "Filing an Issue" and "Special note on Issues" equally
important and would like to suggest consolidating the two sections. I also
feel https://www.gatsbyjs.org/docs/how-to-contribute/#contributing would
do a great job at acting as the introduction to
https://www.gatsbyjs.org/docs/how-to-contribute/. What do you think? Am I
missing the obvious?

/cc @shannonbux https://github.com/shannonbux

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/gatsbyjs/gatsby/issues/3923, or mute the thread
https://github.com/notifications/unsubscribe-auth/Ae9o2tZ4MxOZsFyVUkMHYcnqJzoPjyXaks5tSyZMgaJpZM4R-rYw
.

There should be a single page for "how to file an issue". The "How to Contribute" page has become sprawling and needs split up.

I just went to open a new issue and noticed this nice notification from GitHub 🎉 :

screen shot 2018-02-12 at 10 21 31

I 🤒 don't :sneezing_face: fully understand _how_ but 😻!

wow magical! How nice.

On Tue, Feb 13, 2018 at 8:35 AM, Florian Kissling notifications@github.com
wrote:

I 🤒 don't 🤧 fully understand how but 😻!

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/gatsbyjs/gatsby/issues/3923#issuecomment-365303289,
or mute the thread
https://github.com/notifications/unsubscribe-auth/Ae9o2vKp_Tkna-OQ8yA3Ky-YINa1DXT9ks5tUavSgaJpZM4R-rYw
.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jimfilippou picture jimfilippou  Â·  3Comments

hobochild picture hobochild  Â·  3Comments

kalinchernev picture kalinchernev  Â·  3Comments

dustinhorton picture dustinhorton  Â·  3Comments

3CordGuy picture 3CordGuy  Â·  3Comments