From 90808679de76529e80323f5e8af68c3b010ea30f Mon Sep 17 00:00:00 2001 From: egrace479 Date: Thu, 14 May 2026 15:34:58 -0400 Subject: [PATCH 1/2] Add tip to look at rendering on branch to check citation file --- docs/wiki-guide/GitHub-Repo-Guide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/wiki-guide/GitHub-Repo-Guide.md b/docs/wiki-guide/GitHub-Repo-Guide.md index 5a37de7..d03c694 100644 --- a/docs/wiki-guide/GitHub-Repo-Guide.md +++ b/docs/wiki-guide/GitHub-Repo-Guide.md @@ -115,7 +115,7 @@ Providing this file is as simple as copying the below example and filling in you === "Standard Citation File (Recommended)" - !!! tip + !!! tip "Pro tip" Pair this citation file with a [`.zenodo.json`](#zenodo-metadata) for easier DOI metadata tracking (grants, references, associated papers). ```yaml { py linenums="1" } @@ -215,6 +215,10 @@ Providing this file is as simple as copying the below example and filling in you date-released: ``` +!!! tip "Pro tip" + Check your citation renders correctly on a branch. When you push the `CITATION.cff` to a branch, you can select "Cite this repository" to see if it is rendering as expected: + ![Screenshot of "Cite this repository" pop-up on the Collaborative Distributed Science Guide repository. It shows APA and BibTeX 'content tabs' with the beginnings of a scrollable and copiable citation](images/GH-repo-guide/citation-cff-check.png) + ## Recommended Files Though the following files are not included in every repository and do not have a simple selection process integrated into GitHub, they are extremely important (if not essential) to maintaining FAIR principles and reproducibility in projects, as well as ensuring proper attribution for your work. From af899d23d1b8651636b1c68c06c81e7f85f7ef22 Mon Sep 17 00:00:00 2001 From: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> Date: Thu, 14 May 2026 18:23:19 -0400 Subject: [PATCH 2/2] Improve phrasing for more clarity Co-authored-by: Hilmar Lapp --- docs/wiki-guide/GitHub-Repo-Guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wiki-guide/GitHub-Repo-Guide.md b/docs/wiki-guide/GitHub-Repo-Guide.md index d03c694..3d6a579 100644 --- a/docs/wiki-guide/GitHub-Repo-Guide.md +++ b/docs/wiki-guide/GitHub-Repo-Guide.md @@ -216,7 +216,7 @@ Providing this file is as simple as copying the below example and filling in you ``` !!! tip "Pro tip" - Check your citation renders correctly on a branch. When you push the `CITATION.cff` to a branch, you can select "Cite this repository" to see if it is rendering as expected: + Check whether your citation renders correctly on a branch. When you push the `CITATION.cff` to a branch and browse the repository at that branch, you can select "Cite this repository" in the righthand sidebar to see if it is rendering as expected: ![Screenshot of "Cite this repository" pop-up on the Collaborative Distributed Science Guide repository. It shows APA and BibTeX 'content tabs' with the beginnings of a scrollable and copiable citation](images/GH-repo-guide/citation-cff-check.png) ## Recommended Files