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

[DOC] Update contribution workflow #1562

Merged
merged 6 commits into from
Nov 27, 2023
Merged

Conversation

sappelhoff
Copy link
Member

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:

@sappelhoff sappelhoff added the exclude-from-changelog This item will not feature in the automatically generated changelog label Jul 24, 2023
@sappelhoff sappelhoff requested a review from Remi-Gau July 24, 2023 08:56
@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f86fa84) 87.97% compared to head (fe22532) 87.97%.

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.
📢 Have feedback on the report? Share it here.

tools/add_contributors.py Show resolved Hide resolved
tools/add_contributors.py Outdated Show resolved Hide resolved
Comment on lines +52 to 53
# Set to True to use some of the dummy data in the `new_contributors.tsv`
TEST = True
Copy link
Member Author

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)

Copy link
Collaborator

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

Copy link
Collaborator

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

tools/add_contributors.py Outdated Show resolved Hide resolved
@sappelhoff
Copy link
Member Author

@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:

  1. we don't need to check and keep it up to date (which we haven't done, so our legend is out of date)
  2. the source at allcontributors also lists emoji-to-word mappings that we don't list, but which your newly developed tools apparently support

WDYT?

CONTRIBUTING.md Outdated Show resolved Hide resolved
Release_Protocol.md Outdated Show resolved Hide resolved
DECISION-MAKING.md Outdated Show resolved Hide resolved
tools/add_contributors.py Outdated Show resolved Hide resolved
@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Sep 21, 2023

TODO

@Remi-Gau
Copy link
Collaborator

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)

Copy link
Collaborator

@Remi-Gau Remi-Gau left a 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.

@Remi-Gau Remi-Gau changed the title DOC: contrib workflow [DOC] Update contribution workflow Nov 27, 2023
@Remi-Gau Remi-Gau merged commit 463338d into bids-standard:master Nov 27, 2023
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation exclude-from-changelog This item will not feature in the automatically generated changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants