Skip to content

Commit

Permalink
feat: add more consistent variables
Browse files Browse the repository at this point in the history
  • Loading branch information
maehr committed Apr 30, 2024
1 parent 3b0ae01 commit 32cf4c7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"title": "My Research Software",
"title": "REPO_NAME",
"version": "0.11.2",
"publication_date": "2021-10-13",
"keywords": ["amazing software", "research"],
"license": {
"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",
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down

0 comments on commit 32cf4c7

Please sign in to comment.