Skip to content

Add tip to look at rendering on branch to check citation file #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
egrace479 merged 2 commits into from
May 14, 2026
Merged

Add tip to look at rendering on branch to check citation file #77

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9080867
Add tip to look at rendering on branch to check citation file
egrace479 May 14, 2026
af899d2
Improve phrasing for more clarity
egrace479 May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/wiki-guide/GitHub-Repo-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
Expand Down Expand Up @@ -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.
Expand Down
Loading