diff --git a/docs/wiki-guide/GitHub-Repo-Guide.md b/docs/wiki-guide/GitHub-Repo-Guide.md index 38e3051..a4c163a 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 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 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. diff --git a/docs/wiki-guide/images/GH-repo-guide/citation-cff-check.png b/docs/wiki-guide/images/GH-repo-guide/citation-cff-check.png new file mode 100644 index 0000000..408f1de Binary files /dev/null and b/docs/wiki-guide/images/GH-repo-guide/citation-cff-check.png differ