Guides: Creating GitHub releases and Zenodo DOIs for How-to Guides
GitHub & Zenodo
-
Link your repository to Zenodo. More information is available in GitHub docs.
Adding the DOI to your guide
-
Add the DOI (or even a complete citation!) into your how-to-cite instructions on the
index.mdpage -
Update the DOI field in the
CITATION.cfffile.
Important: A blank
CITATION.cff example is provided below. Don’t forget to fill out the other metadata in this file!cff-version: 0.0.0
message: "Please cite as below."
authors:
- family-names: [family name goes here]
given-names: [given names go here]
orcid: [ORCID goes here]
title: "Title of repository goes here"
version: 0.0.0
doi: [DOI goes here]
date-released: YYYY-MM-DD