Update contributing document and issue templates#1736
Merged
Conversation
- This isn't necessary since it's already in the title. Also formats the various section tips with italic font to make it easier to spot that it's not user written text.
- This isn't necessary since it's already in the title. Also formats the various section tips with italic font to make it easier to spot that it's not user written text. Reword some parts to make them easier to understand and remove others that were too confusing.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduction
Update the contributing document to make it easier to read (hopefully). Also updates the issues templates to make them more helpful.
Closes #1661.
Motivation
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
$was removed from the command line examples since it wasn't very obvious that it represented the command prompt and it could potentially lead someone to believe they needed to type in that character.Proposed solution
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.