Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Adds details on using CITATION.cff #1021

Merged
merged 4 commits into from
Apr 1, 2025
Merged

feature: Adds details on using CITATION.cff #1021

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e71bd58
feature: Adds details on using CITATION.cff
ns-rse Oct 9, 2024
50b9781
Remove CITATION.cff
ns-rse Oct 27, 2024
6e4ddbe
Update episodes/12-citation.md
ns-rse Oct 27, 2024
0936ddb
Apply suggestions from code review
ns-rse Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions episodes/12-citation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/). CFF files are standardized human and machine readable citation
information files 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, integration with both Zenodo and Zotero is supported.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the format is very different, should we provide an example of a cff file as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, if you could make a cff for this lesson it would be great please.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martinosorb please see my explanation above of why I would prefer not to include a CFF for this lesson yet. I understand that the example would be helpful but creating a CFF for this lesson now will cause quite a headache for the Curriculum Team ❤️

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you would like an alternative, I can offer the CFF for the Collaborative Lesson Development Training curriculum, which we are doing our best to keep up to date.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, sorry. I forget the status of things after a while.
I can merge this if you want, but I think, to be honest, that this episode is not really usable at this stage, and should be mostly rewritten eventually.

:::::::::::::::::::::::::::::::::::::::: keypoints

- Add a CITATION file to a repository to explain how you want your work cited.

::::::::::::::::::::::::::::::::::::::::::::::::::