Add beautiful citation directions via CITATION.cff in template
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
The CITATION.cff in a github repo adds a handy citation field and also enhances zenodo entries substantially.
For example, the title and author list of https://zenodo.org/records/14332397 was improved to https://zenodo.org/records/14409147 by the addition of the cff file. That seems a considerable improvement to me.
I do not want to suggest to include in the cff file actual papers, but info about how to cite the software repo. That would also give a good platform to add ORCIDs and all (? guideline incoming?) code contributors.
Possibly the file could be generated partially automatic?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No target file or test is named. Start by locating the repository template and existing metadata files, then review the CITATION.cff guidance. Done means the template contains a valid software citation file covering the repository and contributors, with any automatic-generation scope agreed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100