Skip to content
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

docs: create PR template #195

Merged
merged 3 commits into from
May 23, 2019
Merged

docs: create PR template #195

merged 3 commits into from
May 23, 2019

Conversation

HugoReeves
Copy link
Contributor

Created a pr template in an effort to resolve #187
This should ensure changes to the /data folder are made instead of changes to the README.md directly.
The PR template is below.


Does this pull request include an item addition/removal/edit? yes/no

If you answered yes to the previous question, ensure that your answers to the following questions are all yes; otherwise, delete this template and draft your own PR.

Did you edit the /data directory instead of the README.md? yes/no

Does this PR include only one addition/removal/edit? yes/no

Did you run the make build command following your edits to the /data directory? yes/no

Have you followed the CONTRIBUTING.md guidelines? yes/no

Details

Provide details of your changes here.

@hacdias
Copy link
Member

hacdias commented Aug 27, 2018

@HugoReeves thanks for this contribution! I'd just change the questions to checkboxes though. Like this:

  • I did edit edit the /data directory instead of the README.md.
  • This PR includes only one addition/removal/edit.
  • I run make build command following my edits to the /data directory.
  • I followed the CONTRIBUTING.md guidelines.

@HugoReeves
Copy link
Contributor Author

@hacdias The template now uses checkboxes.

Copy link
Member

@hacdias hacdias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Let's wait for more reviews 😄

@koalalorenzo
Copy link
Member

koalalorenzo commented Aug 27, 2018

Why don't we make comments liens for the first section?

<!--  
My lines of the PR
--!>

In this way we force them to read but it will not appear on every PR.
It might be a small suggestion, but it is ok to leave those visible! What do you think?

@HugoReeves
Copy link
Contributor Author

@koalalorenzo I am happy to include the markdown comment. IMO it is better if we have a checkbox that must be ticked by the pr author. This means that when reviewing pr's we can observe that the author has actively agreed that they followed the CONTRIBUTING.md document.

Once this is resolved, is there any further work that needs to be done to have this pr merged?

@hacdias hacdias changed the title Created PR template docs: create PR template May 23, 2019
@hacdias hacdias merged commit d2adffa into ipfs:master May 23, 2019
@koalalorenzo
Copy link
Member

Thank you! This will help a lot!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

All the new PR are still not populating /data
3 participants