diff --git a/mkdocs.yml b/mkdocs.yml index e1e0dd33..efb46d1b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,6 +73,7 @@ nav: - Data Dissemination and Impact: curating/metrics.md - Resources for Users: - Frequently Asked Questions: curating/faq.md + - Github's "Cite this Repository": curating/github-cite-this-repo.md - Curating Data in Experimental Facilities: managingdata/experimentalfacilitychecklist.md - Data Management Plan (DMP) Guide: managingdata/datamanagementplan.md - About the Data Depot: datadepotrepo/about.md diff --git a/user-guide/curating/github-cite-this-repo.md b/user-guide/curating/github-cite-this-repo.md new file mode 100644 index 00000000..cd483e02 --- /dev/null +++ b/user-guide/curating/github-cite-this-repo.md @@ -0,0 +1,30 @@ +# GitHub's "Cite this Repository" + +GitHub will show a "Cite this repository" link on your repository's homepage when you add a properly-formatted `CITATION.cff` file to your repository's default branch. + +## Steps + +1. Create a `CITATION.cff` file using the [cff-initializer tool](https://citation-file-format.github.io/cff-initializer-javascript/). + + !!! tip + You can add or update this file at any time, **before** a release (if you know the version number in advance) or **after** a release. [Learn more.](#updating-version-in-citation-file) + + !!! important + If you have a build pipeline with a programmatically defined version, consider adjusting it to ensure the `CITATION.cff` file version has correct version number when a new software version is built. + +2. Add the `CITATION.cff` file to the root directory of your repository's default branch. + +3. Verify the "Cite this repository" dropdown appears on your repository homepage. + +## Reference + +### GitHub Documentation + +For details about how GitHub reads the file, see [GitHub's documentation on CITATION files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). + +### Updating Version in Citation File + +You do not need to create a new release version just to add or update a `CITATION.cff` file; GitHub references the file from your default branch. Examples: + +- [adding **before** release](https://github.com/TACC/mkdocs-tacc/pull/36) +- [updating **after** release](https://github.com/TACC/mkdocs-tacc/commit/98c6d867) diff --git a/user-guide/curating/policies.md b/user-guide/curating/policies.md index bca47ad6..b57aeed7 100644 --- a/user-guide/curating/policies.md +++ b/user-guide/curating/policies.md @@ -581,6 +581,7 @@ Below are the requirements for publishing research software in the DDR: * Prior to publishing, users agree that the software is functional and works according to the instructions provided in the readme file. * Research software should be self contained. While it should be possible to use the software with published data in DesignSafe or within DesignSafe Tools and Applications, it should not be written such that it is dependent on absolute file paths in DesignSafe data publications or on external file systems. * Research software publications should not include datasets. Instead datasets that are used by the research software for training, testing, validation, etc. should be published as a stand-alone datasets and linked to the research software publication via the Related Work/linked entry available in the curation form. In turn, a dataset can be related to the research software publication via the Referenced Data and Software/cites entry available in the curation form. +* The citation and DOI obtained should be included in the GitHub repo and [show as Cite this Repository](/user-guide/curating/github-cite-this-repo/). * For guidance on publishing good quality research software, see Research Software Best Practices. What does not qualify as research software: