-
Notifications
You must be signed in to change notification settings - Fork 95
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
[DOC] Adds 'quick start' guidelines for new contributors #293
[DOC] Adds 'quick start' guidelines for new contributors #293
Conversation
Sorry to ask for so many reviewers but if we're successful at OHBM there will be a lot of eyeballs on this; therefore, I'd like more eyeballs on it sooner rather than later! |
Codecov Report
@@ Coverage Diff @@
## master #293 +/- ##
=========================================
- Coverage 49.36% 49.2% -0.17%
=========================================
Files 39 39
Lines 2133 2140 +7
=========================================
Hits 1053 1053
- Misses 1080 1087 +7
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I'm going to be picky I would like it to say "Let us know what your interests are ..." rather than 'skills'. I had no skills when I came to tedana but I was really really interested in seeing some figures for the results so thats what I dove into.
Pickiness is great. I don't know if you knew, but you can mark your review as "request changes" when you do a review, which makes it more explicit that you'd like a change. It also prevents merging. |
So sorry, adding the contributors section added a merge conflict ! Is there any way you could patch that ? |
Okay, I think that's resolved the way we'd like. Let me know if not. |
README.md
Outdated
@@ -82,7 +82,10 @@ Open or comment on one of [our issues](https://github.com/ME-ICA/tedana/issues)! | |||
|
|||
We ask that all contributions to ``tedana`` respect our [code of conduct](https://github.com/ME-ICA/tedana/blob/master/CODE_OF_CONDUCT.md). | |||
|
|||
## Contributors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we still want this heading, just below the quick start recommendation 😸
Also, WDYT about moving up this text to above the code of conduct reminder ? That way it's clear that the CoC governs gitter, too. At least, that's how I'd read it !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, I totally missed this comment until @tsalo pointed it out, my bad. The subtraction was another merge casualty; I really need to be more careful next time.
What would you think about additionally adding a line to clarify that the CoC applies broadly across the project, just to be super-duper clear? I (optimistically) hope it never becomes an issue, but at least then it's clear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @emdupre's point, but other than that it looks good to me.
I've addressed the above, and added more broad applicability to the CoC statement. I can revert the commit or adjust it if it's not what you'd like. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, too ! Thanks !!
Closes #292 .
Changes proposed in this pull request: