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

MAINT: Update CONTRIBUTING.md inspired by dMRIPrep's #1853

Merged
merged 15 commits into from Nov 7, 2019

Conversation

oesteban
Copy link
Member

@oesteban oesteban commented Nov 5, 2019

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.

  • Updated CONTRIBUTING.md file, with clearer specifications about crediting contributors.
  • The PR adds a .maint/ folder with some (maintenance) scripts.
  • The contributors list is not handled by the .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 the update_zenodo.py script. For instance, now we correctly handle several affiliations.
  • A new script .maint/paper_author_list.py generates the authors list and affiliations for papers.
  • Upstreamed some contributors from other projects (niworkflows, sdcflows, smriprep, etc.), such as @mattcieslak or @utooley.
  • Update the Welcome Bot message

@auto-comment
Copy link

auto-comment bot commented Nov 5, 2019

Thank your for raising your pull request.

Some of the fMRIPRep maintainers will review your changes as soon as time permits.
I'm attaching below a Review Checklist for the reviewers, to copy and paste
it in their review comment.

## 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)

@oesteban
Copy link
Member Author

oesteban commented Nov 5, 2019

$ python .maint/paper_author_list.py 
WARNING: Reusing existing line-contributors.txt file.
Some people made commits, but are missing in .maint/ files: Franklin Feingold, Gabriel A. Devenyi, Pablo Velasco, Marc Bue.
Authors (37):
Markiewicz, Christopher J. (1); DuPre, Elizabeth (2); Kent, James D. (3); Ciric, Rastko (1); Salo, Taylor (4); Goncalves, Mathias (1); Urchs, Sebastian (2); Blair, Ross W. (1); Jacoby, Nir (5); Sneve, Markus H. (6); Lurie, Daniel J. (7); Valabregue, Romain (8); Heinsfeld, Anibal S. (9); Halchenko, Yaroslav O. (10); Ma, Feilong (10); Liem, Franz (11); Gomez, Daniel E. P. (12); Ye, Zhifang (13); Erramuzpe, Asier (14); Rivera-Dompenciel, Adriana (3); Adebimpe, Azeez (15); Amlien, Inge K. (6); Cieslak, Matthew (15); Finc, Karolina (16); Ghosh, Satrajit S. (17, 18); Isik, Ayse Ilkay (19); Moodie, Craig A. (1); Naveau, Mikaël (20); Satterthwaite, Theodore D. (15); Sitek, Kevin R. (21); Stojić, Hrvoje (22); Thompson, William H (1); Tooley, Ursula A. (23); Wright, Jessey (1); Gorgolewski, Krzysztof J. (1); Poldrack, Russell A. (1); Esteban, Oscar (1)


Affiliations:
 1. Department of Psychology, Stanford University
 2. Montreal Neurological Institute, McGill University
 3. Neuroscience Program, University of Iowa
 4. Department of Psychology, Florida International University
 5. Department of Psychology, Columbia University
 6. Center for Lifespan Changes in Brain and Cognition, University of Oslo
 7. Department of Psychology, University of California, Berkeley
 8. CENIR, INSERM U1127, CNRS UMR 7225, UPMC Univ Paris 06 UMR S 1127, Institut du Cerveau et de la Moelle épinière, ICM, F-75013, Paris, France
 9. Child Mind Institute
10. Dartmouth College: Hanover, NH, United States
11. URPP Dynamics of Healthy Aging, University of Zurich
12. Donders Institute for Brain, Cognition and Behaviour, Radboud University Nijmegen
13. State Key Laboratory of Cognitive Neuroscience and Learning, Beijing Normal University
14. Computational Neuroimaging Lab, BioCruces Health Research Institute
15. Perelman School of Medicine, University of Pennsylvania, PA, USA
16. Centre for Modern Interdisciplinary Technologies, Nicolaus Copernicus University in Toruń
17. McGovern Institute for Brain Research, MIT, MA, USA
18. Department of Otolaryngology, Harvard Medical School, MA, USA
19. Max Planck Institute for Empirical Aesthetics
20. Cyceron, UMS 3408 (CNRS - UCBN), France
21. Speech & Hearing Bioscience & Technology Program, Harvard University
22. Max Planck UCL Centre for Computational Psychiatry and Ageing Research, University College London
23. Department of Neuroscience, University of Pennsylvania, PA, USA

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 .maint/former.json. That'll keep you out of all our noise.

To the rest of contributors: please check your information is up-to-date (and add affiliations if necessary).

@pvelasco
Copy link
Contributor

pvelasco commented Nov 5, 2019

Hi @oesteban ,
Yes, I would like to be added. My affiliation is:
Center for Brain Imaging, New York University

Thanks!

@oesteban
Copy link
Member Author

oesteban commented Nov 5, 2019

Do you have an ORCID?

Copy link
Collaborator

@mgxd mgxd left a 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

.github/config.yml Outdated Show resolved Hide resolved
@effigies
Copy link
Member

effigies commented Nov 5, 2019

@pvelasco In case this is out of not having run across them as opposed to a principled objection, it takes < 1 minute to register for an ORCID.

.github/config.yml Outdated Show resolved Hide resolved
.github/config.yml Outdated Show resolved Hide resolved
.github/config.yml Outdated Show resolved Hide resolved
.github/config.yml Outdated Show resolved Hide resolved
.github/config.yml Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@pvelasco
Copy link
Contributor

pvelasco commented Nov 5, 2019

@pvelasco In case this is out of not having run across them as opposed to a principled objection, it takes < 1 minute to register for an ORCID.

orcid: 0000-0002-5749-6049

Thanks @effigies

@franklin-feingold
Copy link
Contributor

@oesteban sounds great!
Affiliation: Stanford University
ORCID: 0000-0002-6533-2909

@gdevenyi
Copy link
Contributor

gdevenyi commented Nov 6, 2019

Cheers, thanks for reaching out:
Affiliation: McGill University, Department of Psychiatry
https://orcid.org/0000-0002-7766-1187

@effigies effigies force-pushed the docs/contributing-update-dmriprep branch from 56ce0a5 to 3e8e092 Compare November 6, 2019 14:43
@effigies
Copy link
Member

effigies commented Nov 6, 2019

Updated the mailmap to deduplicate some and provide full/real names:

$ git shortlog -ns
  1928	Oscar Esteban
  1199	Christopher J. Markiewicz
   719	Krzysztof J. Gorgolewski
   428	Ross Blair
   312	Shoshana Berleant
   140	James D. Kent
   109	Elizabeth DuPre
    71	Mathias Goncalves
    42	Rastko Ciric
    24	Anibal Sólon Heinsfeld
    19	Romain Valabregue
    19	Franklin Feingold
    17	Markus H. Sneve
     9	Craig Moodie
     9	Nir Jacoby
     8	Zhifang Ye
     8	Daniel J. Lurie
     7	Feilong Ma
     7	Taylor Salo
     6	Asier Erramuzpe
     5	Yaroslav Halchenko
     5	Franz Liem
     3	Zeynep Enkavi
     3	William Hedley Thompson
     3	Inge Amlien
     3	Adriana Rivera-Dompenciel
     2	Ilkay Isik
     2	Hrvoje Stojic
     2	Jarod Roland
     2	Kevin Sitek
     2	Sebastian Urchs
     1	Daniel Gomez
     1	Mikael Naveau
     1	Saren Seeley
     1	Jakub Kaczmarzyk
     1	Sebastien Naze
     1	Ali Cohen
     1	Matteo Visconti di Oleggio Castello
     1	The Gitter Badger
     1	Ursula Tooley
     1	Marcel Falkiewicz
     1	Marc Bue
     1	Gabriel A. Devenyi
     1	Pablo Velasco

CONTRIBUTING.md Outdated Show resolved Hide resolved
.mailmap Show resolved Hide resolved
@emdupre
Copy link
Collaborator

emdupre commented Nov 6, 2019

(I'll review this in the next hour, sorry for the delay !)

@oesteban oesteban force-pushed the docs/contributing-update-dmriprep branch from 2bbd566 to 692df33 Compare November 6, 2019 17:40
Copy link
Collaborator

@emdupre emdupre left a 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 !

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
@oesteban
Copy link
Member Author

oesteban commented Nov 7, 2019

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:

$ python .maint/paper_author_list.py 
Running git-line-summary on repo
Some people made commits, but are missing in .maint/ files: Marc Bue.
Authors (40):
Markiewicz, Christopher J. (1); DuPre, Elizabeth (2); Kent, James D. (3); Ciric, Rastko (1); Salo, Taylor (4); Goncalves, Mathias (1); Feingold, Franklin (1); Urchs, Sebastian (2); Blair, Ross W. (1); Jacoby, Nir (5); Sneve, Markus H. (6); Lurie, Daniel J. (7); Valabregue, Romain (8); Heinsfeld, Anibal S. (9); Halchenko, Yaroslav O. (10); Ma, Feilong (10); Erramuzpe, Asier (11); Devenyi, Grabriel A. (12); Liem, Franz (13); Gomez, Daniel E. P. (14); Ye, Zhifang (15); Velasco, Pablo (16); Rivera-Dompenciel, Adriana (3); Adebimpe, Azeez (17); Amlien, Inge K. (6); Cieslak, Matthew (17); Finc, Karolina (18); Ghosh, Satrajit S. (19, 20); Isik, Ayse Ilkay (21); Moodie, Craig A. (1); Naveau, Mikaël (22); Satterthwaite, Theodore D. (17); Sitek, Kevin R. (23); Stojić, Hrvoje (24); Thompson, William H (1); Tooley, Ursula A. (25); Wright, Jessey (1); Gorgolewski, Krzysztof J. (1); Poldrack, Russell A. (1); Esteban, Oscar (1)


Affiliations:
 1. Department of Psychology, Stanford University
 2. Montreal Neurological Institute, McGill University
 3. Neuroscience Program, University of Iowa
 4. Department of Psychology, Florida International University
 5. Department of Psychology, Columbia University
 6. Center for Lifespan Changes in Brain and Cognition, University of Oslo
 7. Department of Psychology, University of California, Berkeley
 8. CENIR, INSERM U1127, CNRS UMR 7225, UPMC Univ Paris 06 UMR S 1127, Institut du Cerveau et de la Moelle épinière, ICM, F-75013, Paris, France
 9. Child Mind Institute
10. Dartmouth College: Hanover, NH, United States
11. Computational Neuroimaging Lab, BioCruces Health Research Institute
12. Department of Psychiatry, McGill University
13. URPP Dynamics of Healthy Aging, University of Zurich
14. Donders Institute for Brain, Cognition and Behaviour, Radboud University Nijmegen
15. State Key Laboratory of Cognitive Neuroscience and Learning, Beijing Normal University
16. Center for Brain Imaging, New York University
17. Perelman School of Medicine, University of Pennsylvania, PA, USA
18. Centre for Modern Interdisciplinary Technologies, Nicolaus Copernicus University in Toruń
19. McGovern Institute for Brain Research, MIT, MA, USA
20. Department of Otolaryngology, Harvard Medical School, MA, USA
21. Max Planck Institute for Empirical Aesthetics
22. Cyceron, UMS 3408 (CNRS - UCBN), France
23. Speech & Hearing Bioscience & Technology Program, Harvard University
24. Max Planck UCL Centre for Computational Psychiatry and Ageing Research, University College London
25. Department of Neuroscience, University of Pennsylvania, PA, USA

@marcbue, you'd be still in time to add your name to the contributors.json

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-Authored-By: Elizabeth DuPre <emd222@cornell.edu>
@emdupre
Copy link
Collaborator

emdupre commented Nov 7, 2019

One more comment, sorry ! I went and checked the rendered CONTRIBUTING and realized one badge wasn't rendering properly.

But then 👍 from me !

Copy link
Collaborator

@jdkent jdkent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, great work!

Copy link
Collaborator

@mgxd mgxd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great

@effigies effigies merged commit ccf2375 into nipreps:master Nov 7, 2019
@oesteban oesteban deleted the docs/contributing-update-dmriprep branch September 4, 2020 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants