docs: add CITATION.cff and DOI badge to make citing burst2safe easier - #255
Open
ltianyi992 wants to merge 1 commit into
Open
docs: add CITATION.cff and DOI badge to make citing burst2safe easier#255ltianyi992 wants to merge 1 commit into
ltianyi992 wants to merge 1 commit into
Conversation
Users wanting to cite burst2safe in academic work currently have no discoverable pointer in the repository. The Zenodo DOI and citation info were discussed in ASFHyP3#152 but never committed. Changes: CITATION.cff — CFF 1.2.0 file with full author list, Zenodo concept DOI (10.5281/zenodo.14538103), license, and keywords. GitHub surfaces a "Cite this repository" button that generates APA and BibTeX output from this file automatically. README.md — Adds a Zenodo DOI badge below the title and a new "Citation" section with the recommended APA citation for v2.0.2, a link to the Zenodo record for other formats, and a note about the CITATION.cff button. Closes ASFHyP3#254
Contributor
|
Thanks Claude, we'll need to add ORCIDs for the people who have them as well as ensure all the netries have propper names. There's a few citation.cff files in this org that that information could be gathered from. We may also need to include a gitmapping like in nisar-docs to combine differently styled commmits. See latest prior work in these two PRs: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Closes #254
Users wanting to cite
burst2safein academic work have no discoverable citation pointer in the repository. The Zenodo DOI and example citation were provided in discussion #152 but never committed to the repo.Changes
CITATION.cff(new file)A Citation File Format 1.2.0 file with:
10.5281/zenodo.14538103GitHub automatically detects
CITATION.cffand shows a "Cite this repository" button on the repo homepage that generates APA and BibTeX output.README.mdDOI badge added below the title — links directly to the Zenodo concept record (always resolves to the latest version):
Citation section added before the License section with: