Feat: add citation.cff details #540
Merged
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
|
pre-commit.ci autofix |
There was a problem hiding this comment.
Pull Request Overview
This PR adds detailed documentation on how to cite software via CITATION.cff files and integrate with Zenodo.
- Introduce “Citation.cff files” section with explanation and benefits
- Describe date tracking fields and update practices
- Show example YAML and explain Zenodo integration
Comments suppressed due to low confidence (1)
documentation/repository-files/license-files.md:133
- [nitpick] Use consistent casing for the citation file name—e.g., 'CITATION.cff'—to match the actual filename and other headings.
While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
|
I've committed the changes! @tkoyama010 |
|
@all-contributors please add @schwalbe10 for code, review |
|
I've put up a pull request to add @schwalbe10! 🎉 |
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.
fix #34