MRG, DOC: overhaul contributor guide#6254
Conversation
|
This is a long-needed overhaul, thanks for tackling this @drammock |
Codecov Report
@@ Coverage Diff @@
## master #6254 +/- ##
=======================================
Coverage 89.18% 89.18%
=======================================
Files 416 416
Lines 74954 74954
Branches 12353 12353
=======================================
Hits 66845 66845
Misses 5225 5225
Partials 2884 2884 |
|
If it's good to go, feel free to set to MRG and tell me you did it (GitHub does not notify of title changes) and I'll take a deeper look at the CircleCI render |
|
Here is the rendered page: @larsoner @massich ready for review. @ikojcic you might also be interested, since we discussed the need for this last week. |
|
We can not require |
larsoner
left a comment
There was a problem hiding this comment.
Just a few small comments to start, I'll look fully tomorrow. Feel free to fix now or wait until I comment more fully.
| $ # (same command works to add a completely new file): | ||
| $ git add mne/some_file.py | ||
| $ # enter interactive staging mode, to add only portions of the file: | ||
| $ git add -p mne/viz/some_other_file.py |
There was a problem hiding this comment.
This interactive bit seems like overkill / expert territory.
FWIW 99% of the time I just do git commit -am "whatever". Might be simpler than telling people to do it one by one.
There was a problem hiding this comment.
When I was starting with git learning about -p actually made my life easier - beginnings are often messy and its good to know how to clean up. So it would be nice to still keep this information somwhere.
There was a problem hiding this comment.
I've left this in because I agree with @mmagnuski, add -p is really useful for beginners I think.
larsoner
left a comment
There was a problem hiding this comment.
Okay I think that's it for me :)
|
Here's the rendered page: https://12967-1301584-gh.circle-artifacts.com/0/dev/contributing.html |
agramfort
left a comment
There was a problem hiding this comment.
besides my nitpick it's great !!!
|
Great, thanks @drammock ! I'll merge and if there are more tweaks people want, we can make new PRs |
|
Thanks heaps !
|
|
great! |
Closes #6179
CONTRIBUTING.rstto the repository root, that gives a short overview of how to contributedoc/contributing.rstto give more detailed guidance and bring it up to date.doc/configure_git.rstanddoc/customize_git.rst; give just enough detail indoc/contributing.rstto get people off the ground, and point them to the many other resources for further git learningcc @massich @jasmainak @jeythekey