[ENH] use citation.cff to store affiliations of authors #3754
Conversation
|
👋 @Remi-Gau Thanks for creating a PR! Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft. Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.
For new features:
For bug fixes:
We will review it as quick as possible, feel free to ping us with questions if needed. |
|
Other benefits of citation.cff files: they add "cite this repo" button on github
|
|
If there is interest for this options the next step would be:
What this does not cover are all the contributors listed in the names.rst files. |
|
@bthirion this is what the citation file would look like. |
Codecov Report
@@ Coverage Diff @@
## main #3754 +/- ##
=======================================
Coverage 91.52% 91.52%
=======================================
Files 133 133
Lines 15561 15561
Branches 3229 3229
=======================================
Hits 14242 14242
Misses 772 772
Partials 547 547
Flags with carried forward coverage won't be shown. Click here to find out more. see 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
I think we need to upgrade the authors list to include recent contributors. |
You mean update AUTHORS.rst with people listed here: https://github.com/nilearn/nilearn/blob/main/doc/changes/names.rst |
|
The doc build failure looks related, isnt'it ? |
yup. |
|
Random thought: looking up all the affiliations of all contributors may be something that we want to keep as a good first issue for the OHBM hackathon. It could be a good way for people to who want to practice git and opening pull requests... And teach them about the joy of editing yml files... |
|
make sure |
| # Update the authors file and the names file | ||
| # in case a contributor has been added to citation.cff | ||
| # but did not run the maint_tools/citation_cff_maint.py script. | ||
| - name: update AUTHORS.rst and doc/changes/names.rst | ||
| run: python maint_tools/citation_cff_maint.py |
There was a problem hiding this comment.
Since running citation_cff_maint.py is automated can we keep the instructions simple for 1st time contributors so all they have to do is add their names to citation.cff ?
There was a problem hiding this comment.
yup I was thinking about that too: will update
There was a problem hiding this comment.
update the contributing.rst also with an example of what to add in the citation.cff
|
ok will merge this one as we will need it for the hackathon |
Relates to #1511
Changes proposed in this pull request: