Promote citation file to standard and add DOI note #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Citation files are important for provenance of research software, we expect them
egrace479
added
documentation
This was referenced Oct 24, 2025
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Oct 29, 2025
Pull from Collab Guide [PR 24](Imageomics/Collaborative-distributed-science-guide#24) * Add note on which DOI to use from Zenodo and why, link for reference * Move citation to standard files section Citation files are important for provenance of research software, we expect them * Add clarification about updating throughout project lifespan, link to project life cycle
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Oct 29, 2025
Pull from Collab Guide [PR 24](Imageomics/Collaborative-distributed-science-guide#24) * Add note on which DOI to use from Zenodo and why, link for reference * Move citation to standard files section Citation files are important for provenance of research software, we expect them * Add clarification about updating throughout project lifespan, link to project life cycle
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Oct 29, 2025
Pull from Collab Guide [PR 24](Imageomics/Collaborative-distributed-science-guide#24) * Add note on which DOI to use from Zenodo and why, link for reference * Move citation to standard files section Citation files are important for provenance of research software, we expect them * Add clarification about updating throughout project lifespan, link to project life cycle
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Oct 31, 2025
Pull from Collab Guide [PR 24](Imageomics/Collaborative-distributed-science-guide#24) * Add note on which DOI to use from Zenodo and why, link for reference * Move citation to standard files section Citation files are important for provenance of research software, we expect them * Add clarification about updating throughout project lifespan, link to project life cycle
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moves
CITATION.cffinto the "Standard Files" section.- We expect citation instructions to be made available, this is automatically read when integrating with Zenodo (an added note in the section), and this also would hopefully help in inspiring an earlier authorship conversation for a project.
- I fit this last note on authorship in with note on project life cycle—is this link better as a footnote?
Adds note on using the version agnostic Zenodo DOI for citation in repository.
- Included as both a comment in the template
CITATION.cffand in the note admonition preceding it. The motivation is provided in the latter.I plan to add a
.zenodo.jsonfile to the "Recommended Files" section, so it will still be plural. I just didn't want to overload this PR. That update will also include some editing/links between this and the Zenodo part of the DOI Generation page.