Skip to content

Commit 3e8ee00

Browse files
committed
updated some things as requested in PR #252
1 parent 330303f commit 3e8ee00

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,19 @@
22
title: 'Next step: Citation data'
33
---
44

5-
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:
5+
It is likely that your `CITATION.cff` currently doesn't pass validation. The error messages you get from the [`cffconvert`]({{cookiecutter.repository}}/actions/workflows/cffconvert.yml) GitHub Action are unfortunately a bit cryptic, but doing the following helps:
6+
7+
- [ ] Check if the `given-name` and `family-name` keys need updating. If your family 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
8+
- [ ] 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/).
9+
- [ ] Add more authors if needed
10+
- [ ] Update `date-released` using the YYYY-MM-DD format.
11+
- [ ] 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.
12+
- [ ] Update the `keywords` array with some keywords of your own that describe your project.
13+
14+
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.
15+
16+
17+
To help you keep the citation metadata up to date and synchronized, the [`cffconvert`]({{cookiecutter.repository}}/actions/workflows/cffconvert.yml) GitHub Action checks the following 6 aspects:
618

719
1. Whether your repository includes a `CITATION.cff` file.
820

@@ -29,14 +41,3 @@ The repository has been set up with a [GitHub action](https://github.com/marketp
2941
1. Whether `CITATION.cff` and `.zenodo.json` contain equivalent data.
3042

3143
_This final check verifies that the two files are in sync. The check ignores CITATION.cff's `version`, `commit`, and `date-released`._
32-
33-
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:
34-
35-
- [ ] Check if the `given-name` and `family-name` keys need updating. If your family 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
36-
- [ ] 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/).
37-
- [ ] Add more authors if needed
38-
- [ ] Update `date-released` using the YYYY-MM-DD format.
39-
- [ ] 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.
40-
- [ ] Update the `keywords` array with some keywords of your own that describe your project.
41-
42-
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

Comments
 (0)