From 32cf4c788a2f3f67883c34a3da9e7ac7a086da99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Tue, 30 Apr 2024 10:59:33 +0200 Subject: [PATCH] feat: add more consistent variables --- .zenodo.json | 4 ++-- CITATION.cff | 6 +++--- README.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.zenodo.json b/.zenodo.json index fea9cca..064d911 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,5 +1,5 @@ { - "title": "My Research Software", + "title": "REPO_NAME", "version": "0.11.2", "publication_date": "2021-10-13", "keywords": ["amazing software", "research"], @@ -7,7 +7,7 @@ "id": "AGPL-3.0" }, "upload_type": "software", - "description": "This is my awesome research software. It does many things.", + "description": "SHORT_DESCRIPTION", "creators": [ { "name": "Doe, John", diff --git a/CITATION.cff b/CITATION.cff index e4248bd..b076c2d 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,4 +1,4 @@ -abstract: 'This is my awesome research software. It does many things.' +abstract: 'SHORT_DESCRIPTION' authors: - family-names: Doe given-names: John @@ -17,6 +17,6 @@ keywords: - research license: Apache-2.0 message: 'If you use this software, please cite it using the metadata from this file.' -repository-code: 'https://github.com/citation-file-format/my-research-software' -title: 'My Research Software' +repository-code: 'https://github.com/USERNAME/REPO_NAME/' +title: 'REPO_NAME' version: 0.11.2 diff --git a/README.md b/README.md index 756c56c..d33b09c 100644 --- a/README.md +++ b/README.md @@ -68,9 +68,9 @@ npm run prepare - [ ] enable [GitHub security alerts](https://github.blog/2017-11-16-introducing-security-alerts-on-github/) - [ ] [protect](https://help.github.com/en/articles/configuring-protected-branches) the main branch to enforce a [fork and pull](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow -- [ ] search and replace `FULLNAME`, `USERNAME`, `REPO_NAME`, `SHORT_DESCRIPTION` `[INSERT CONTACT METHOD]` in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [package.json](package.json), [README.template.md](README.template.md), [SECURITY.md](SECURITY.md) -- [ ] change `CITATION.CFF` according to [citation-file-format.github.io](https://citation-file-format.github.io/) -- [ ] change `.zenodo.json` according to [zenodo.org](https://developers.zenodo.org/?python#add-metadata-to-your-github-repository-release) +- [ ] search and replace `FULLNAME`, `USERNAME`, `REPO_NAME`, `SHORT_DESCRIPTION` `[INSERT CONTACT METHOD]` in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [package.json](package.json), [README.template.md](README.template.md), [SECURITY.md](SECURITY.md), [CITATION.CFF](CITATION.CFF), [.zenodo.json](.zenodo.json) +- [ ] change `CITATION.CFF` according to [citation-file-format.github.io](https://citation-file-format.github.io/) (or delete it) +- [ ] change `.zenodo.json` according to [zenodo.org](https://developers.zenodo.org/?python#add-metadata-to-your-github-repository-release) (or delete it) - [ ] setup the [Zenodo integration](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content) - [ ] add `ZENODO_RECORD` to [README.md](README.md) - [ ] add favicons to `./`, e.g. via [favicon.io](https://favicon.io/)