New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing document and issue templates #1736

Merged
merged 3 commits into from Jan 8, 2018

Conversation

Projects
None yet
1 participant
@ricardograca
Member

ricardograca commented Jan 8, 2018

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.

ricardograca added some commits Jan 8, 2018

Remove Name from issue template
- 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.
Remove Name from Pull Request template
- 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.

@ricardograca ricardograca added the docs label Jan 8, 2018

@ricardograca ricardograca merged commit ad3ee99 into master Jan 8, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@ricardograca ricardograca deleted the rg-contributing-doc branch Jan 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment