Skip to content

Commit 056252b

Browse files
committed
even more tweaking
1 parent c2eec95 commit 056252b

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ labels:
66

77
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:
88

9-
1. Whether your repository includes a `CITATION.cff` file
9+
1. Whether your repository includes a `CITATION.cff` file.
1010

1111
_By including this file, authors of the software can receive credit for the work they put in._
1212

13-
1. Whether your `CITATION.cff` is valid YAML
13+
1. Whether your `CITATION.cff` is valid YAML.
1414

1515
_Visit https://yamllint.com to see if the contents of your CITATION.cff are valid YAML._
1616

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`).
1818

1919
_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._
2020

@@ -24,11 +24,11 @@ The repository has been set up with a [GitHub action](https://github.com/marketp
2424

2525
_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._
2626

27-
1. Whether `.zenodo.json` is valid JSON
27+
1. Whether `.zenodo.json` is valid JSON.
2828

2929
_Currently unimplemented, but you can check for yourself on [https://jsonlint.com/](https://jsonlint.com/)._
3030

31-
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data
31+
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data.
3232

3333
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and `date-released`._
3434

0 commit comments

Comments
 (0)