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
MAINT: Update CONTRIBUTING.md
inspired by dMRIPrep's
#1853
MAINT: Update CONTRIBUTING.md
inspired by dMRIPrep's
#1853
Conversation
Thank your for raising your pull request. Some of the fMRIPRep maintainers will review your changes as soon as time permits. ## PR Review
*Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
- [ ] As the reviewer I confirm that there are no conflicts of interest for me to review this work.
Please check what applies in the following aspects of the PR:
#### Code documentation
- [ ] New functions and modules are documented following the guidelines.
- [ ] Existing code required amendments in documentation and has been updated.
- [ ] Sufficient inline comments ensure readability by other contributors in the long term.
#### Documentation site
- [ ] The modifications to *fMRIPrep* in this PR **do not require extra documentation**. This is a common situation when a bug fix that does not change the code base substantially is submitted.
- [ ] This PR requires documentation. The corresponding documentation will be submitted as an additional PR in the future.
- [ ] This PR requires extra documentation, and will be included within this PR. Please check the boxes that apply best:
- [ ] An existing feature is substantially modified, changing the interface and/or logic of a module.
- [ ] A new feature is being added, therefore full documentation of it will be included
- [ ] This PR addresses an error in existing documentation.
- [ ] Yes, all expected sections of documentation were generated by the CI build, and look as expected
#### Tests
- [ ] The new functionalities in this PR are covered by the existing tests
- [ ] New test batteries have been included with this PR
#### Data
- [ ] This PR does not require any additional data to be uploaded to OSF.
- [ ] This PR requires additional data for tests.
#### Dependencies: smriprep
- [ ] This PR does not require any update on `smriprep`; or
- [ ] `smriprep` has correctly been pinned.
#### Dependencies: niworkflows
- [ ] This PR does not require any update on `niworkflows`; or
- [ ] `niworkflows` has correctly been pinned.
#### Dependencies: sdcflows
- [ ] This PR does not require any update on `sdcflows`; or
- [ ] `sdcflows` has correctly been pinned.
#### Dependencies: Nipype
- [ ] This PR does not require any update on `nipype`; or
- [ ] `nipype` has correctly been pinned.
#### Dependencies: other
- [ ] This PR does not require any update on other dependencies; or
- [ ] other dependencies have correctly been pinned.
#### Reports generated within CI tests
- [ ] Yes, I have checked the reports of ds005 and they are not modified or the changes are as expected
- [ ] Yes, I have checked the reports of ds054 and they are not modified or the changes are as expected
- [ ] Yes, I have checked the reports of ds010 and they are not modified or the changes are as expected
### Review Comments (other than those left inline with the code)
|
The script identified that @franklin-feingold, @gdevenyi, @pvelasco and @marcbue contributed but are not in the contributors list. Please let me know whether you want to be added, and if so your affiliation(s) and ORCID. If you want to be kept out of all the buzz, please let me know and I'll add you to a new file called To the rest of contributors: please check your information is up-to-date (and add affiliations if necessary). |
Hi @oesteban , Thanks! |
Do you have an ORCID? |
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.
looks good! one minor suggestion
@oesteban sounds great! |
Cheers, thanks for reaching out: |
56ce0a5
to
3e8e092
Compare
Updated the mailmap to deduplicate some and provide full/real names:
|
(I'll review this in the next hour, sorry for the delay !) |
Co-Authored-By: Mathias Goncalves <goncalves.mathias@gmail.com> Co-Authored-By: Chris Markiewicz <effigies@gmail.com>
2bbd566
to
692df33
Compare
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 this is a huge improvement overall !
I made a first pass on comments with a few clarifications. Let me know what you think !
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
add note about ica-aroma in foundational principles
… labels [skip ci]
Okay latest changes - thumbs up to this? We can open an issue to revisit how we can size contributions to sort authors. Current paper listing output is:
@marcbue, you'd be still in time to add your name to the contributors.json |
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
One more comment, sorry ! I went and checked the rendered CONTRIBUTING and realized one badge wasn't rendering properly. But then 👍 from me ! |
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, great work!
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.
looks great
Hi fMRIPrep enthusiasts!
To push #1808 forward, this PR transfers most of the language from dMRIPrep, and better characterizes how fMRIPrep credits collaborators and friends.
.maint/
folder with some (maintenance) scripts..zenodo.json
file, because their schema does not capture completely our needs. Instead, it is generated automatically (pulling the ordering magic from nipype ideas) with theupdate_zenodo.py
script. For instance, now we correctly handle several affiliations..maint/paper_author_list.py
generates the authors list and affiliations for papers.