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

Update contributors.md #1561

Closed
wants to merge 1 commit into from
Closed

Conversation

francopestilli
Copy link
Collaborator

@francopestilli francopestilli commented Jul 21, 2023

I updated my contribution, in preparation for the BIDS town hall

I updated my contribution, in preparation for the BIDS town hall
@codecov
Copy link

codecov bot commented Jul 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (28beccd) 87.83% compared to head (7fccfc3) 87.83%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1561   +/-   ##
=======================================
  Coverage   87.83%   87.83%           
=======================================
  Files          16       16           
  Lines        1356     1356           
=======================================
  Hits         1191     1191           
  Misses        165      165           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Remi-Gau
Copy link
Collaborator

@francopestilli

This file should not be edited directly: see

<!-- THE SECTION BELOW IS AUTOMATICALLY GENERATED -->

We should probably find a way to make this more unmissable or have CI notify people when only this file is edited.

@sappelhoff sappelhoff marked this pull request as draft July 22, 2023 20:05
@sappelhoff
Copy link
Member

@francopestilli I have added your contribution here: https://github.com/bids-standard/bids-specification/wiki/Recent-Contributors

This follows our workflow to update contributions to BIDS. Could you please also tell us an email we can use in your contributor profile?

@Remi-Gau, see how I added Franco (screenshot below):

image

I only put the name and added the single emoji that was updated (added). The docs currently don't say whether for an update all previous information must be reproduced, or whether adding the new items is sufficient. What do you think?

The docs on how to sync contributors currently say:

  • add new contributors info to the tools/new_contributors.tsv file.

However, it's not entirely clear to me with which workflow (copy paste / manual editing?) one should go from this (screenshot below):

image

To this (screenshot below):

image

see also how in the screenshot of the TSV file, it says "idea" instead of the idea emoji 💡 --> shouldn't we always paste the exact emojis into that file?


Another issue I see relates to the workflow in the makefile:

update_contributors:
	python tools/add_contributors.py
	python tools/print_contributors.py
	yarn all-contributors generate

I don't think it says anywhere in the docs that yarn is needed

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

placing this here as a visual aid to not merge this PR (we will use a different workflow to update Franco's contributions, thanks Franco! 🙏 )

@Remi-Gau
Copy link
Collaborator

I think I am probably going to add a github action workflow that posts in a PR if it modifies the contributors file in the appendix.

The message should link to the contributors section in the wiki and tell people to add their info there instead.

@Remi-Gau
Copy link
Collaborator

which workflow (copy paste / manual editing?) one should go from this (screenshot below)

currently this must be done manually (copy pasting)

@Remi-Gau
Copy link
Collaborator

shouldn't we always paste the exact emojis into that file?

Thinking again about this: we should probably only allow just the words a not the emoji to be added in the tsv (easier for the code and less cognitive effort when adding contributions)

@Remi-Gau
Copy link
Collaborator

I only put the name and added the single emoji that was updated (added). The docs currently don't say whether for an update all previous information must be reproduced, or whether adding the new items is sufficient. What do you think?

I think that the sensible behavior is:

  • for contributions are just added (we just check there is no duplicates): I don't think we will want to remove contributions
  • for all other fields:
    • if the value in the tsv is empty we do not change it
    • if there is a non empty value in the tsv then it replaces the previous one we have in store

@Remi-Gau
Copy link
Collaborator

@francopestilli your contribution will be updated as part of #1651
I will close this PR after #1651 is merged but will keep track of what was discussed here to improve our "contributors workflow".

@sappelhoff
Copy link
Member

@sappelhoff sappelhoff closed this Nov 27, 2023
@sappelhoff sappelhoff deleted the francopestilli-patch-1 branch November 27, 2023 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants