From e71bd58c57bff6cac5984383f8032fee5b32583e Mon Sep 17 00:00:00 2001 From: Neil Shephard Date: Wed, 9 Oct 2024 12:03:30 +0100 Subject: [PATCH 1/4] feature: Adds details on using CITATION.cff Adds details on using [Citation File Format](https://citation-file-format.github.io) in a repository and includes such a file for the repository itself. --- CITATION.cff | 34 ++++++++++++++++++++++++++++++++++ episodes/12-citation.md | 11 +++++++++-- 2 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..f758e59962 --- /dev/null +++ b/CITATION.cff @@ -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 diff --git a/episodes/12-citation.md b/episodes/12-citation.md index ed2b75bee5..41ca401c7d 100644 --- a/episodes/12-citation.md +++ b/episodes/12-citation.md @@ -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 +(`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. + +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. + :::::::::::::::::::::::::::::::::::::::: keypoints - Add a CITATION file to a repository to explain how you want your work cited. :::::::::::::::::::::::::::::::::::::::::::::::::: - - From 50b9781b5e6a1e8e47ba4529e3150d76ee644ba0 Mon Sep 17 00:00:00 2001 From: Neil Shephard Date: Sun, 27 Oct 2024 20:00:38 +0000 Subject: [PATCH 2/4] Remove CITATION.cff --- CITATION.cff | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index f758e59962..0000000000 --- a/CITATION.cff +++ /dev/null @@ -1,34 +0,0 @@ -# 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 From 6e4ddbe75697b6ae3d97f375c28e9d9838fa1a40 Mon Sep 17 00:00:00 2001 From: Neil Shephard Date: Sun, 27 Oct 2024 20:01:19 +0000 Subject: [PATCH 3/4] Update episodes/12-citation.md Co-authored-by: Toby Hodges --- episodes/12-citation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/episodes/12-citation.md b/episodes/12-citation.md index 41ca401c7d..e67fabce5c 100644 --- a/episodes/12-citation.md +++ b/episodes/12-citation.md @@ -58,6 +58,8 @@ information for software and datasets. If you host your repository on GitHub thi 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. +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. From 0936ddbbf7f5198985c255ff86bc0263c266ee19 Mon Sep 17 00:00:00 2001 From: Neil Shephard Date: Mon, 20 Jan 2025 14:46:07 +0000 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Martino Sorbaro --- episodes/12-citation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/episodes/12-citation.md b/episodes/12-citation.md index e67fabce5c..f62ba0c9f6 100644 --- a/episodes/12-citation.md +++ b/episodes/12-citation.md @@ -52,11 +52,11 @@ 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. +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.