feature: Adds details on using CITATION.cff #1021
+11
−2
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,10 +52,19 @@ There is also an [`@software{...`](https://www.google.com/search?q=git+citation+ | |
| no "umbrella" citation like a paper or book exists for the project you want to | ||
| make citable. | ||
|
|
||
| Finally you may wish to include citation information in a [Citation File Format | ||
| (`CITATION.cff`)](https://citation-file-format.github.io/) which are standardized human and machine readable citation | ||
| information for software and datasets. If you host your repository on GitHub this information is automatically linked | ||
| and rendered on the repository page and a BibTeX snippet is provided which users can copy and paste making it easy for | ||
| your project to be cited. Further there is integration with both Zenodo and Zotero. | ||
ns-rse marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
ns-rse marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| A [chapter of The Turing Way](https://the-turing-way.netlify.app/communication/citable/citable-cite#citing-software) provides more detail on how you can use CFF files to make your software citable. | ||
|
|
||
| You can use the [cff-init](https://citation-file-format.github.io/cff-initializer-javascript/#/) website to easily | ||
| create and update a `CITATION.cff` file. | ||
|
|
||
|
There was a problem hiding this comment. If the format is very different, should we provide an example of a cff file as well? There was a problem hiding this comment. Could perhaps update this repositories CITATION to the CFF format to serve as an example and link to it. Perhaps address as a separate issue? There was a problem hiding this comment. Yes, if you could make a cff for this lesson it would be great please. |
||
| :::::::::::::::::::::::::::::::::::::::: keypoints | ||
|
|
||
| - Add a CITATION file to a repository to explain how you want your work cited. | ||
|
|
||
| :::::::::::::::::::::::::::::::::::::::::::::::::: | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this a little vague. "you may wish" why exactly? What is the difference compared to CITATION.txt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for not getting back sooner.
CFF is a YAML format with defined fields which makes them machine readable. Whilst possible to stick
CITATIONin to any repository it doesn't conform to this standard and makes it harder to then parse and collate such information across published software.GitHub has CFF integration and it makes links available to export the citation in different formats.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like how you explained it to me in this comment, it's more explicit and pedagogical than the description in the lesson. However, I think this whole episode should be reorganized a bit, so it's ok for now.