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

Update contributing guidelines with style suggestions for pull requests #7

Closed
KirstieJane opened this issue Apr 11, 2018 · 3 comments
Closed
Labels
documentation issues related to improving documentation for the project enhancement issues describing possible enhancements to the project help wanted issues where we're particularly excited for contributions mozsprint Issues highlighted for the 2018 Mozilla Global Sprint
Milestone

Comments

@KirstieJane
Copy link
Member

I've noticed that the PRs for tedana often have labels like [WIP], [TST], [ENH] associated with them.

I think it makes sense to explain in the contributing guidelines what they mean and how to use them for new pull requests.

You could also consider a pull request template. @Islast has a really lovely one for Brain Networks in Python.

Here's a github help article about pull request templates.

@emdupre emdupre added enhancement issues describing possible enhancements to the project help wanted issues where we're particularly excited for contributions mozsprint Issues highlighted for the 2018 Mozilla Global Sprint labels Apr 11, 2018
@emdupre
Copy link
Member

emdupre commented Apr 11, 2018

Yes, PR label conventions would be something to include in more general style guidelines ! I'm planning to add those— maybe in the documentation itself, with a link out from the Contributing file. Something like these suggested tags from Nibabel.

I love the idea of a pull request template too, though ! Would be great to have help in creating one for this repo.

@KirstieJane
Copy link
Member Author

My favourite thing about @Islast's template is the checkbox that tells me whether it's ready for review. I get the notifications when she pushes commits but I know not to go and check it out until that checkbox is ✅!

Isla's on holiday at the moment but I'm sure she'd be delighted to help out when she's back in about 1 week (or other folks could share their experiences too) ✨

@Islast
Copy link

Islast commented Apr 19, 2018

Hi, just saw this in my notifications and I thought I'd say hi! I think pull request templates are great. One tip I have if you decide to do one is that if you look at the raw file of ours you'll see a section in a ! html tag:

<!---
This is a suggested pull request template for the BrainNetworksInPython. 
We don't mind whether or not you use it. It's just a list of useful 
questions to answer. :)
-->

Github markdown doesn't render anything enclosed in this tag so it's useful for leaving an explanatory message to your pull-requester 💫

@emdupre emdupre added the documentation issues related to improving documentation for the project label Apr 25, 2018
@emdupre emdupre added this to the 0.1.0 milestone May 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project enhancement issues describing possible enhancements to the project help wanted issues where we're particularly excited for contributions mozsprint Issues highlighted for the 2018 Mozilla Global Sprint
Projects
None yet
Development

No branches or pull requests

3 participants