Skip to content

Commit 9897f47

Browse files
committed
updated template for updating citation information
1 parent ac511e2 commit 9897f47

1 file changed

Lines changed: 55 additions & 1 deletion

File tree

{{cookiecutter.project_name}}/.github/next_steps/04_citation.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,58 @@ labels:
44
- 'action required'
55
---
66

7-
Citation data instructions
7+
The repository has been set up with a [GitHub action](https://github.com/marketplace/actions/cffconvert) that monitors
8+
your citation data. It checks the following 6 aspects:
9+
10+
1. Whether your repository includes a `CITATION.cff` file
11+
12+
_By including this file, authors of the software can receive credit for the work they put in._
13+
14+
1. Whether your `CITATION.cff` is valid YAML
15+
16+
_Visit https://yamllint.com to see if the contents of your CITATION.cff are valid YAML._
17+
18+
1. Whether your `CITATION.cff` adheres to the schema (as listed in the `CITATION.cff` file itself under key `cff-version`
19+
20+
_The Citation File Format schema can be found [here](https://github.com/citation-file-format/citation-file-format),
21+
along with an explanation of all the keys. You're advised to use the latest available schema version._
22+
23+
1. Whether your repository includes a `.zenodo.json` file.
24+
25+
_With this file, you can control what metadata should be associated with any future releases of your software on
26+
Zenodo: things like the author names, along with their affiliations and their ORCIDs, the license under which the
27+
software has been released, as well as the name of your software and a short description. If your repository doesn't
28+
have a .zenodo.json file, Zenodo will take a somewhat crude guess to assign these metadata.
29+
30+
The `cffconvert` GitHub action will tell you what it expects to find in `.zenodo.json`, just copy and paste it to a
31+
new file named `.zenodo.json`. The suggested text ignores CITATION.cff's `version`, `commit`, and `date-released`.
32+
`cffconvert` considers these keys `suspect` in the sense that they are often out of date, and there is little
33+
purpose to telling Zenodo about these properties: Zenodo already knows._
34+
35+
1. Whether `.zenodo.json` is valid JSON
36+
37+
_Currently unimplemented, but you can check for yourself on [https://jsonlint.com/](https://jsonlint.com/)._
38+
39+
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data
40+
41+
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and
42+
`date-released`._
43+
44+
45+
It is likely that your `CITATION.cff` currently doesn't pass validation. The error messages you get from cffconvert are
46+
unfortunately a bit cryptic, but doing the following likely helps:
47+
48+
- [ ] Fill in your given name for `given-name`
49+
- [ ] Check if the `family-name` key needs updating. If your last name has a name particle like `von` or `van` or `de`, use
50+
the `name-particle` key; if your name has a suffix like `Sr` or `IV`, use name-suffix. For details, refer to the
51+
schema description: https://github.com/citation-file-format/citation-file-format
52+
- [ ] Update the value of the `orcid` key. If you do not have an orcid yet, you can get one here
53+
[https://orcid.org/](https://orcid.org/).
54+
- [ ] Update `date-released` using the YYYY-MM-DD format
55+
- [ ] Update the `doi` key with the conceptDOI for your repository (see [https://help.zenodo.org](https://help.zenodo.org/)
56+
for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string `10.0000/FIXME`
57+
to pass validation.
58+
- [ ] Update the `keywords` array with some keywords of your own that describe your project
59+
60+
Once you do all the steps above, the `cffconvert` workflow will tell you what content it expected to see in
61+
`.zenodo.json`. Copy-paste from the GitHub Action log into a new file `.zenodo.json`.

0 commit comments

Comments
 (0)