[DOC] add examples/clarify CONTRIBUTORS.md #1566
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think it's Ready To Merge ?
…On Mon., Apr. 1, 2019, 15:27 James Kent, ***@***.***> wrote:
Changes proposed in this pull request
fixes #1565 <#1565>
- add example pull requests to each type (e.g. STY, DOC, ENH, etc)
- add link to add/commit/push files
- change pull request link to forked repositories (since that is the
workflow that fmriprep promotes)
Documentation that should be reviewed
The CONTRIBUTORS.md file
@ariveradompenciel <https://github.com/ariveradompenciel> could you see
if this updated CONTRIBUTING.md
<https://github.com/jdkent/fmriprep/blob/contrib_clarity/CONTRIBUTING.md>
addresses your suggestions?
@effigies <https://github.com/effigies>, @oesteban
<https://github.com/oesteban>, @emdupre <https://github.com/emdupre> : I
do not know what RTM means (it's not Read The Manual), sorry I'm not
keeping up with the lingo. But I would like to add an entry for that, which
I can do as soon as I know what it means.
------------------------------
You can view, comment on, or merge this pull request online at:
#1566
Commit Summary
- make some clarifications and add more examples [skip ci]
File Changes
- *M* CONTRIBUTING.md
<https://github.com/poldracklab/fmriprep/pull/1566/files#diff-0> (30)
Patch Links:
- https://github.com/poldracklab/fmriprep/pull/1566.patch
- https://github.com/poldracklab/fmriprep/pull/1566.diff
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#1566>, or mute the thread
<https://github.com/notifications/unsubscribe-auth/AOUk58MUy6SQL9njqGrjECQvYEPvd2Wbks5vcl2jgaJpZM4cWcoY>
.
|
jdkent
commented
Apr 1, 2019
CONTRIBUTING.md
Outdated
| @@ -229,11 +231,21 @@ You're awesome. :wave::smiley: | |||
| [link_helpwanted]: https://github.com/poldracklab/fmriprep/labels/help%20wanted | |||
| [link_feature]: https://github.com/poldracklab/fmriprep/labels/feature | |||
|
|
|||
| [link_pullrequest]: https://help.github.com/articles/creating-a-pull-request/ | |||
| [link_pullrequest]:https://help.github.com/en/articles/creating-a-pull-request-from-a-fork | |||
There was a problem hiding this comment.
Forgot a space here and I should get rid of the /en/ in the path name
CONTRIBUTING.md
Outdated
| [link_fork]: https://help.github.com/articles/fork-a-repo/ | ||
| [link_pushpullblog]: https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/ | ||
| [link_branches]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/ | ||
| [link_add_commit_push]: https://help.github.com/en/articles/adding-a-file-to-a-repository-using-the-command-line |
There was a problem hiding this comment.
Remove /en/ here too.
|
Yeah, it would be ready-to-merge, but I'm not sure we ever actually use it. More often, we tag with WIP and just remove the tag when it's ready for review/merge. |
|
So it's kind of complimentary with |
|
Thank you! This definitely addresses my suggestions! |
…into contrib_clarity
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request
fixes #1565
STY,DOC,ENH, etc)Documentation that should be reviewed
The CONTRIBUTORS.md file
@ariveradompenciel could you see if this updated CONTRIBUTING.md addresses your suggestions?
@effigies, @oesteban, @emdupre : I do not know what
RTMmeans (it's not Read The Manual), sorry I'm not keeping up with the lingo. But I would like to add an entry for that, which I can do as soon as I know what it means.