-
Notifications
You must be signed in to change notification settings - Fork 50
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
Add Zenodo DOI to README.md #2479
Conversation
This should also be added to Citation.cff, right? |
Yes, the citation file should also be updated, I'll add that to this PR as well. |
The DOI I added to README.md is the umbrella DOI (10.5281/zenodo.3370873, it always resolves to the latest version). The DOI I added to CITATION.cff is for the specific release (10.5281/zenodo.3370874). I did this because the Citation File Format requires a version and release date, so it made more sense to use the specific DOI for it in the citation file. Anyone have any input on what DOIs to put where? Should README.md have the umbrella DOI or should we update it for every release? |
I think what you proposed makes sense, although having to update the citation file for each release seems unfortunate. Looking at Github code search for other citation files (https://github.com/search?q=extension%3Acff+zenodo&type=Code), it seems that at least some other projects use the Zenodo DOI without version/release date (e.g. https://github.com/amusecode/amuse/blob/master/CITATION.cff) , so we might want to consider doing that as well. |
Yeah, I think I prefer using the umbrella DOI everywhere, but I'm hesitant to buck the standard. |
db6c196
to
781f552
Compare
Add DOI and related information to CITATION.cff and README.md
No description provided.