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

Add Zenodo DOI to README.md #2479

Merged
merged 4 commits into from
Aug 27, 2019
Merged

Add Zenodo DOI to README.md #2479

merged 4 commits into from
Aug 27, 2019

Conversation

rbuch
Copy link
Contributor

@rbuch rbuch commented Aug 19, 2019

No description provided.

matthiasdiener
matthiasdiener previously approved these changes Aug 19, 2019
@matthiasdiener
Copy link
Contributor

This should also be added to Citation.cff, right?

@rbuch
Copy link
Contributor Author

rbuch commented Aug 19, 2019

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.

@rbuch
Copy link
Contributor Author

rbuch commented Aug 19, 2019

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?

@matthiasdiener
Copy link
Contributor

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.

@matthiasdiener matthiasdiener added this to the 6.10.0 milestone Aug 19, 2019
@rbuch
Copy link
Contributor Author

rbuch commented Aug 19, 2019

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.

CITATION.cff Outdated Show resolved Hide resolved
@rbuch rbuch merged commit 3891836 into master Aug 27, 2019
@rbuch rbuch deleted the add-doi-to-readme branch August 27, 2019 21:03
stwhite91 pushed a commit that referenced this pull request May 11, 2023
Add DOI and related information to CITATION.cff and README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants