Skip to content

Commit

Permalink
Modified title in CITATION.cff and added a note on the default type t…
Browse files Browse the repository at this point in the history
…o the README file.
  • Loading branch information
andreaschrader committed Jan 4, 2024
1 parent 9994391 commit 1e989da
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ references:
type: website
url: "https://coderefinery.github.io/github-without-command-line/doi/"
repository-code: "https://github.com/andreaschrader/doi-exercise"
title: "andreaschrader/doi-exercise"
title: andreaschrader/doi-exercise
version: 1.1
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ The instructions worked smoothly in my hands. Thanks to the authors!
**cff**:
In addition to the persistent identifier, a citation file can be added to the root of the repository. Following the respective [GitHub CITATION.cff](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) documentation, a respectively created cff file in the root [can be considered by Zenodo](https://github.com/citation-file-format/citation-file-format/issues/374) in order to read proper metadata with respect to authors, affiliations and e.g. licenses and is displayed in the right side-bar at GitHub.

Here, I selected from the options described in the [citation file format (cff) repository](https://github.com/citation-file-format/citation-file-format/tree/main)'s (doi: 10.5281/zenodo.1003149) [schema-guide.md](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md) to create a [`CITATION.cff`](./CITATION.cff) file for this repository.
Here, I selected from the options described in the [citation file format (cff) repository](https://github.com/citation-file-format/citation-file-format/tree/main)'s (doi: 10.5281/zenodo.1003149) [schema-guide.md](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md) to create a [`CITATION.cff`](./CITATION.cff) file for this repository. Note, currently, only the types `software` and `dataset` can be selected and if non is selected, `software` is the default.

**zenodo.json**:
However, if a `.zenodo.json` file was created as well following [this documentation](https://developers.zenodo.org/#github), according to the [Zenodo FAQ on GitHub for CITATION.cff](https://help.zenodo.org/faq/#github), the `.zenodo.json metadata` is used for the Zenodo record.
Expand Down

0 comments on commit 1e989da

Please sign in to comment.