Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Update contributing document and issue templates #1736
Update the contributing document to make it easier to read (hopefully). Also updates the issues templates to make them more helpful.
The first header in the issue templates was unnecessary and duplicated the Title that is already available in the GitHub issue tracker. Some parts were also a bit confusing and their purpose was unclear. Finally the tips for the different sections are sometimes left intact by users, which makes it harder to tell at first glance that the user hasn't filled in these sections.
On the contributing document the
In the issue templates simply remove the duplicated Name, add italic font format to the tips sections so they stand out more if left intact and reword or remove text that is not clear.
In the contributing doc the changes are mainly reformatting so that it's easier to read.
Current PR Issues
Maybe it would be interesting to also add a section explaining that the user is supposed to remove the pre-written text on the issue templates and that it's ok to remove sections that don't make sense or for which they don't have anything to say.