From 207fa2e6b2b497298599cd8e77509165746897e0 Mon Sep 17 00:00:00 2001 From: schwalbe10 Date: Sat, 12 Jul 2025 11:27:54 -0700 Subject: [PATCH 1/4] add citation details --- .../repository-files/license-files.md | 37 +++++++++++++++++-- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/documentation/repository-files/license-files.md b/documentation/repository-files/license-files.md index 0346388a..be7c70f8 100644 --- a/documentation/repository-files/license-files.md +++ b/documentation/repository-files/license-files.md @@ -130,13 +130,42 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include ## What about software citation? -While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using Zenodo. +While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). - +#### What citation.cff files add to your repository + +When you add a `CITATION.cff` file to your repository, GitHub automatically detects it and displays a "Cite this repository" button. This makes it easy for users to properly cite your software. The file contains standardized citation information that tools and services can automatically read and use. GitHub will generate both APA and BibTeX citation formats for users. + +#### How dates are tracked in citation.cff files + +The citation file tracks important dates for your software. The `date-released` field shows when the current version was released. The `date-published` field shows when the software was first made available. You also include a `version` field with the specific version number. + +You should update these dates with each new release so people cite the correct version of your software. + +#### Integration with Zenodo + +Citation.cff files work well with Zenodo, which is a popular place to store research software and get DOIs. When you create a Zenodo release, it can automatically pull information from your citation file. This keeps your citation information the same between GitHub and Zenodo. You can also include your Zenodo DOI in the citation file. Each time you make a new GitHub release, it can create a new Zenodo version with updated citation information. + + +Here's a basic example of what a `CITATION.cff` file might look like: + +```yaml +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: "Your Last Name" + given-names: "Your First Name" + orcid: "https://orcid.org/0000-0000-0000-0000" +title: "Your Package Name" +version: 1.0.0 +doi: 10.5281/zenodo.1234 +date-released: 2025-07-12 +url: "https://github.com/yourusername/your-package" +``` # References From a55fc2161f59a65db9077104aecbf69c06b30cbb Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 12 Jul 2025 19:18:39 +0000 Subject: [PATCH 2/4] =?UTF-8?q?'[pre-commit.ci=20=F0=9F=A4=96]=20Apply=20c?= =?UTF-8?q?ode=20format=20tools=20to=20PR'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documentation/repository-files/license-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/repository-files/license-files.md b/documentation/repository-files/license-files.md index be7c70f8..e03df6fe 100644 --- a/documentation/repository-files/license-files.md +++ b/documentation/repository-files/license-files.md @@ -142,7 +142,7 @@ When you add a `CITATION.cff` file to your repository, GitHub automatically dete #### How dates are tracked in citation.cff files -The citation file tracks important dates for your software. The `date-released` field shows when the current version was released. The `date-published` field shows when the software was first made available. You also include a `version` field with the specific version number. +The citation file tracks important dates for your software. The `date-released` field shows when the current version was released. The `date-published` field shows when the software was first made available. You also include a `version` field with the specific version number. You should update these dates with each new release so people cite the correct version of your software. From 7ee50b8138154f286bd8c99eafc122a91cfea25b Mon Sep 17 00:00:00 2001 From: Kyohei Sahara Date: Sat, 12 Jul 2025 14:00:49 -0700 Subject: [PATCH 3/4] Update documentation/repository-files/license-files.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- documentation/repository-files/license-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/repository-files/license-files.md b/documentation/repository-files/license-files.md index e03df6fe..7215b902 100644 --- a/documentation/repository-files/license-files.md +++ b/documentation/repository-files/license-files.md @@ -130,7 +130,7 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include ## What about software citation? -While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). +While many permissive licenses do not require citation, we strongly encourage that you cite all software that you use in papers, blogs, and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). ### Citation.cff files: Making your software citable From 2de2859eb1fdff2492ea2a34aae96f85ee715b33 Mon Sep 17 00:00:00 2001 From: Kyohei Sahara Date: Sat, 12 Jul 2025 14:01:03 -0700 Subject: [PATCH 4/4] Update documentation/repository-files/license-files.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- documentation/repository-files/license-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/repository-files/license-files.md b/documentation/repository-files/license-files.md index 7215b902..e98f54a0 100644 --- a/documentation/repository-files/license-files.md +++ b/documentation/repository-files/license-files.md @@ -162,7 +162,7 @@ authors: orcid: "https://orcid.org/0000-0000-0000-0000" title: "Your Package Name" version: 1.0.0 -doi: 10.5281/zenodo.1234 +doi: "10.5281/zenodo.1234" date-released: 2025-07-12 url: "https://github.com/yourusername/your-package" ```