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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feature: Adds details on using CITATION.cff #1021

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 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
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
34 changes: 34 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: 'Software Carpentry: Version Control with Git'
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Ivan
family-names: Gonzalez
- given-names: Daisie
family-names: Huang
- given-names: Nima
family-names: Hejazi
- given-names: Katherine
family-names: Kozair
- given-names: Madicken
family-names: Munk
identifiers:
- type: doi
value: 10.5281/zenodo.3264950
repository-code: 'https://github.com/swcarpentry/git-novice'
url: 'https://swcarpentry.github.io/git-novice/'
abstract: >-
An introduction to version control for novices using Git
from the Software Carpentries.
keywords:
- git
- software carpentry
- version control
- learning resource
license: CC-BY-SA-4.0
11 changes: 9 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,17 @@ 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
Copy link
Contributor

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?

(`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.
Comment on lines +55 to +59
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
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.

I added a few commas and tried to improve the flow.


ns-rse marked this conversation as resolved.
Show resolved Hide resolved
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?

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

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

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