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 CONTRIBUTING.md #68

Open
Robadob opened this issue Mar 12, 2025 · 1 comment
Open

Update CONTRIBUTING.md #68

Robadob opened this issue Mar 12, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Robadob
Copy link
Member

Robadob commented Mar 12, 2025

do you have any threshold in mind for adding people to acknowledgements and/or CITATION.cff? Or include anyone with at least one merged commit?

Not really, on Zenodo I think there's both "author" and "contributor" (and it defaults to making anyone with a single commit author).

I suppose author would probably mean having contributed at least one sub-section/exercise or significant rewrite, whereas contributor is a single commit which could be as small as a typo fix (or even reviewer). We should probably flesh this out in the contributing.md to save any arguments down the line.

Citation cff would be authors, acknowledgments would be everyone (e.g. there's no harm in having a long list of names or github aliases of people that have made commits).

This is all negotiable as far as I'm concerned, the more input and feedback the better at this stage.

Originally posted by @Robadob in #66 (comment)

@Robadob Robadob added the documentation Improvements or additions to documentation label Mar 12, 2025
@Robadob
Copy link
Member Author

Robadob commented Mar 13, 2025

Not really, on Zenodo I think there's both "author" and "contributor" (and it defaults to making anyone with a single commit author).

I think after citation.cff is setup, it copies authors from that rather than commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant