You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: {{cookiecutter.project_name}}/.github/next_steps/04_citation.md
+10-27Lines changed: 10 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,7 @@ labels:
4
4
- 'action required'
5
5
---
6
6
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:
7
+
The repository has been set up with a [GitHub action](https://github.com/marketplace/actions/cffconvert) that monitors your citation data. It checks the following 6 aspects:
9
8
10
9
1. Whether your repository includes a `CITATION.cff` file
11
10
@@ -17,45 +16,29 @@ your citation data. It checks the following 6 aspects:
17
16
18
17
1. Whether your `CITATION.cff` adheres to the schema (as listed in the `CITATION.cff` file itself under key `cff-version`
19
18
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._
19
+
_The Citation File Format schema can be found [here](https://github.com/citation-file-format/citation-file-format), along with an explanation of all the keys. You're advised to use the latest available schema version._
22
20
23
21
1. Whether your repository includes a `.zenodo.json` file.
24
22
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.
23
+
_With this file, you can control what metadata should be associated with any future releases of your software on Zenodo: things like the author names, along with their affiliations and their ORCIDs, the license under which the software has been released, as well as the name of your software and a short description. If your repository doesn't have a .zenodo.json file, Zenodo will take a somewhat crude guess to assign these metadata._
29
24
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._
25
+
_The `cffconvert` GitHub action will tell you what it expects to find in `.zenodo.json`, just copy and paste it to a new file named `.zenodo.json`. The suggested text ignores CITATION.cff's `version`, `commit`, and `date-released`. `cffconvert` considers these keys `suspect` in the sense that they are often out of date, and there is little purpose to telling Zenodo about these properties: Zenodo already knows._
34
26
35
27
1. Whether `.zenodo.json` is valid JSON
36
28
37
29
_Currently unimplemented, but you can check for yourself on [https://jsonlint.com/](https://jsonlint.com/)._
38
30
39
31
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data
40
32
41
-
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and
42
-
`date-released`._
33
+
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and `date-released`._
43
34
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:
35
+
It is likely that your `CITATION.cff` currently doesn't pass validation. The error messages you get from `cffconvert` are unfortunately a bit cryptic, but doing the following likely helps:
47
36
48
37
-[ ] 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
-[ ] 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/).
38
+
-[ ] Check if the `family-name` key needs updating. If your last name has a name particle like `von` or `van` or `de`, use the `name-particle` key; if your name has a suffix like `Sr` or `IV`, use name-suffix. For details, refer to the schema description: https://github.com/citation-file-format/citation-file-format
39
+
-[ ] Update the value of the `orcid` key. If you do not have an orcid yet, you can get one here [https://orcid.org/](https://orcid.org/).
54
40
-[ ] 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.
41
+
-[ ] Update the `doi` key with the conceptDOI for your repository (see [https://help.zenodo.org](https://help.zenodo.org/) 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` to pass validation.
58
42
-[ ] Update the `keywords` array with some keywords of your own that describe your project
59
43
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`.
44
+
Once you do all the steps above, the `cffconvert` workflow will tell you what content it expected to see in `.zenodo.json`. Copy-paste from the GitHub Action log into a new file `.zenodo.json`. Afterwards, the `cffconvert` GitHub Action should be green.
0 commit comments