-
Notifications
You must be signed in to change notification settings - Fork 169
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
[DOC] Update contribution workflow #1562
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1562 +/- ##
=======================================
Coverage 87.97% 87.97%
=======================================
Files 16 16
Lines 1356 1356
=======================================
Hits 1193 1193
Misses 163 163 ☔ View full report in Codecov by Sentry. |
# Set to True to use some of the dummy data in the `new_contributors.tsv` | ||
TEST = True |
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.
Somewhere else in the docs it say one can run the scripts with an empty new_contributors.tsv
file to update everything (I guess avatar links etc.).
It confuses me that the new_contributors.tsv
file currently contains dummy data: As a maintainer executing the updating steps: can I remove the dummy data? Should I add it back later?
Shouldn't such dummy data better be located under for example tools/tests/data/dummy_new_contributors.tsv
?
(Apart from this, I am still lacking a workflow to go from the wiki format to the TSV format)
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.
Shouldn't such dummy data better be located under for example
tools/tests/data/dummy_new_contributors.tsv
?
yes that would be preferable indeed
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 am still lacking a workflow to go from the wiki format to the TSV format
currently this is done "by hand" by whoever needs to update the contributors page
@Remi-Gau should we perhaps remove our own copy of the "all contributors emoji key" from our WIKI https://github.com/bids-standard/bids-specification/wiki/Recent-Contributors#contributors ??? I think leaving the link to the source is more reasonable for two reasons:
WDYT? |
Co-authored-by: Stefan Appelhoff <[email protected]>
TODO
|
Note: the update_contributors.py script can add new contributions to an already existing contributor so the wiki should also be used to update the list of contributions of anyone (make sure this is clear in our internal doc) |
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.
Good with me.
I will address the points raised here in another PR.
based on #1561 I took a deeper dive into our new contributor acknowledgement tooling (thanks @Remi-Gau!) and made some minor doc adjustments.
Some things still need to be clarified, as also discussed in: