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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ labels:
6
6
7
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:
8
8
9
-
1. Whether your repository includes a `CITATION.cff` file
9
+
1. Whether your repository includes a `CITATION.cff` file.
10
10
11
11
_By including this file, authors of the software can receive credit for the work they put in._
12
12
13
-
1. Whether your `CITATION.cff` is valid YAML
13
+
1. Whether your `CITATION.cff` is valid YAML.
14
14
15
15
_Visit https://yamllint.com to see if the contents of your CITATION.cff are valid YAML._
16
16
17
-
1. Whether your `CITATION.cff` adheres to the schema (as listed in the `CITATION.cff` file itself under key `cff-version`
17
+
1. Whether your `CITATION.cff` adheres to the schema (as listed in the `CITATION.cff` file itself under key `cff-version`).
18
18
19
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._
20
20
@@ -24,11 +24,11 @@ The repository has been set up with a [GitHub action](https://github.com/marketp
24
24
25
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._
26
26
27
-
1. Whether `.zenodo.json` is valid JSON
27
+
1. Whether `.zenodo.json` is valid JSON.
28
28
29
29
_Currently unimplemented, but you can check for yourself on [https://jsonlint.com/](https://jsonlint.com/)._
30
30
31
-
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data
31
+
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data.
32
32
33
33
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and `date-released`._
0 commit comments