feat: .zenodo.json added fix #8

[maehr]

Pull request

Proposed changes

• Fix Publish Repository on Zenodo for Better Data Preservation #8

Types of changes

• New feature (non-breaking change which adds functionality).
• Enhancement (non-breaking change which enhances functionality)
• Bug Fix (non-breaking change which fixes an issue).
• Breaking change (fix or feature that would cause existing functionality to change).

Checklist

• I have read the README document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.

Summary by CodeRabbit

• Documentation
  • Updated metadata for the "My Research Software" project to enhance clarity and compliance with Zenodo guidelines.

[coderabbitai]

Walkthrough

The changes involve refining metadata for the "REPO_NAME" project in various files. This includes updating the abstract, repository URL, and title in CITATION.cff, adding tasks in README.md, and enhancing metadata in .zenodo.json for Zenodo compliance.

Changes

File	Change Summary
CITATION.cff	- Updated abstract, repository URL, and title to placeholders for "REPO_NAME."
README.md	- Added tasks to update CITATION.CFF and .zenodo.json following guidelines.
.zenodo.json	- Enhanced metadata with version, publication date, keywords, license, and more details.

Assessment against linked issues

Objective	Addressed	Explanation
Publish Repository on Zenodo for Better Data Preservation	✅	The changes align with the objective by updating metadata in .zenodo.json for Zenodo compliance.

Poem

🐇✨
In the fields of code, where data does roam,
A rabbit hopped in, making Zenodo its home.
Tags and versions, all neatly aligned,
In a digital burrow, where searches do wind.
Hop, skip, a commit, a push, and a cheer,
For software so fine, let's give a big ear! 🎉
🐇✨

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5f88bdd and 8a602c1.

Files selected for processing (1)

• README.md (3 hunks)

Additional Context Used

LanguageTool (62)

README.md (62)

Near line 3: Possible spelling mistake found.
Context: ...es.github.com/) for documentation, and Zenodo for long-term arc...

---

Near line 15: Unpaired symbol: ‘]’ seems to be missing
Context: ... and encourage collaboration - Increase security - Follow accepted [...

---

Near line 16: Unpaired symbol: ‘]’ seems to be missing
Context: ...security - Follow accepted ethics ## How this template h...

---

Near line 22: Possible spelling mistake found.
Context: ...te helps you ### Open research data - Citeable via DOI (and [C...

---

Near line 23: Unpaired symbol: ‘]’ seems to be missing
Context: .../)) - Automatic long-term archiving via Zenodo - Licensed ...

---

Near line 23: Possible spelling mistake found.
Context: ...)) - Automatic long-term archiving via Zenodo - Licensed under ...

---

Near line 24: Unpaired symbol: ‘]’ seems to be missing
Context: ...Y 4.0 license](LICENSE.md) according to [The Turing Way](https://the-turing-way.n...

---

Near line 30: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) according to [keepachangelog.com](https://keepachangel...

---

Near line 32: Possible spelling mistake found.
Context: ...hub.com/orhun/git-cliff) - package.json via [npm docs](https://docs.npmjs.com/...

---

Near line 32: Unpaired symbol: ‘]’ seems to be missing
Context: ...iff) - package.json via [npm docs](https://docs.npmjs.com/cli/v7/...

---

Near line 32: Possible spelling mistake found.
Context: ...ff) - package.json via [npm docs](https://docs.npmjs.com/cli/v7/con...

---

Near line 33: Unpaired symbol: ‘]’ seems to be missing
Context: ...ge-json) - Accessible documentation via [gh-pages](https://help.github.com/en/art...

---

Near line 33: Possible spelling mistake found.
Context: ...e-json) - Accessible documentation via [gh-pages](https://help.github.com/en/articles/co...

---

Near line 37: Unpaired symbol: ‘]’ seems to be missing
Context: ...onsistency - Consistent formatting via Prettier - Consis...

---

Near line 38: Unpaired symbol: ‘]’ seems to be missing
Context: ...conventionalcommits.org/en/v1.0.0/) via [husky](https://github.com/typicode/husky...

---

Near line 39: Unpaired symbol: ‘]’ seems to be missing
Context: ...code/husky) - Consistent versioning via [Semantic Versioning](https://semver.org/...

---

Near line 40: Unpaired symbol: ‘]’ seems to be missing
Context: ...r324/ce0505fbed06b947d962) workflow via [GitHub branch protection](https://docs.g...

---

Near line 41: Unpaired symbol: ‘]’ seems to be missing
Context: ...rotection-rule) - Consistent issues via [issue templates](https://docs.github.com...

---

Near line 42: Unpaired symbol: ‘]’ seems to be missing
Context: ...y) - Consistent pull request labels via [labeler](https://github.com/actions/labe...

---

Near line 42: Possible spelling mistake found.
Context: ...) - Consistent pull request labels via labeler - ...

---

Near line 47: Unpaired symbol: ‘]’ seems to be missing
Context: ...urity - SECURITY.md per [GitHub](https://docs.github.com/en/code-...

---

Near line 47: Possible typo: you repeated a word
Context: ...rity - SECURITY.md per GitHub - [GitHub Security Alerts](https://github.blog/20...

---

Near line 53: Unpaired symbol: ‘]’ seems to be missing
Context: ...CONDUCT.md](CODE_OF_CONDUCT.md) per the [Contributor Covenant](https://www.contri...

---

Near line 54: Unpaired symbol: ‘]’ seems to be missing
Context: ...g/) - Friendly initial interactions via [Greetings](https://github.com/actions/st...

---

Near line 69: Unpaired symbol: ‘]’ seems to be missing
Context: ...emplate for your project: - [ ] enable [GitHub security alerts](https://github.b...

---

Near line 71: Possible spelling mistake found.
Context: ...d962) workflow - [ ] search and replace FULLNAME, USERNAME, REPO_NAME, `SHORT_DESCR...

---

Near line 71: Possible spelling mistake found.
Context: ...T.md](CODE_OF_CONDUCT.md), package.json, [README.template.md](README.template....

---

Near line 71: Unpaired symbol: ‘]’ seems to be missing
Context: ...EADME.template.md](README.template.md), SECURITY.md - [ ] setup th...

---

Near line 72: The verb ‘set up’ is spelled as two words. The noun ‘setup’ is spelled as one.
Context: ...e.md), SECURITY.md - [ ] setup the [Zenodo integration](https://docs.g...

---

Near line 72: Unpaired symbol: ‘]’ seems to be missing
Context: ...CURITY.md](SECURITY.md) - [ ] setup the [Zenodo integration](https://docs.github....

---

Near line 72: Possible spelling mistake found.
Context: ...URITY.md](SECURITY.md) - [ ] setup the [Zenodo integration](https://docs.github.com/en...

---

Near line 73: Possible spelling mistake found.
Context: ...ferencing-and-citing-content) - [ ] add ZENODO_RECORD to README.md - [ ]...

---

Near line 73: Unpaired symbol: ‘]’ seems to be missing
Context: ...g-content) - [ ] add ZENODO_RECORD to README.md - [ ] add favicons...

---

Near line 74: Unpaired symbol: ‘]’ seems to be missing
Context: ...d) - [ ] add favicons to ./, e.g. via favicon.io - [ ] s...

---

Near line 76: Unpaired symbol: ‘]’ seems to be missing
Context: ... documentation) and fix it - [ ] delete README.md - [ ] rename [READ...

---

Near line 77: Unpaired symbol: ‘]’ seems to be missing
Context: ...DME.template.md](README.template.md) to README.md - [ ] run `npm run...

---

Near line 78: Possible spelling mistake found.
Context: ...md) to README.md - [ ] run npm run format to format all files - [ ] r...

---

Near line 79: Possible spelling mistake found.
Context: ...n formatto format all files - [ ] runnpm run commit` to commit all changes - [ ]...

---

Near line 80: Possible spelling mistake found.
Context: ...committo commit all changes - [ ] runnpm run changelog` and include the output i...

---

Near line 80: Unpaired symbol: ‘]’ seems to be missing
Context: ...un changelog` and include the output in CHANGELOG.md - [ ] enable...

---

Near line 81: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/art...

---

Near line 81: Possible spelling mistake found.
Context: ...ANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/articles/co...

---

Near line 85: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add a CITATION.CFF according to [citation-file-format.github.io](https://...

---

Near line 85: The official name of this software platform is spelled with a capital “H”.
Context: ...CFF` according to [citation-file-format.github.io](https://citation-file-format.github...

---

Near line 86: Possible spelling mistake found.
Context: ...ion-file-format.github.io/) - [ ] add a .zenodo.json according to [zenodo.org](https:/...

---

Near line 86: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add a .zenodo.json according to [zenodo.org](https://developers.zenodo.or...

---

Near line 118: Possible typo: you repeated a whitespace
Context: ...more people can benefit from it. | Type | Platforms ...

---

Near line 118: Possible typo: you repeated a whitespace
Context: ... | Platforms | | ------------------------------------...

---

Near line 120: Possible typo: you repeated a whitespace
Context: ...----------------- | | 🚨 Bug Reports | [GitHub Issue Tracker](https://github....

---

Near line 120: Possible typo: you repeated a whitespace
Context: ...aehr/open-research-data-template/issues) | | 📊 Report bad data ...

---

Near line 121: Possible typo: you repeated a whitespace
Context: ...te/issues) | | 📊 Report bad data | [GitHub Issue Tracker](https://github....

---

Near line 121: Possible typo: you repeated a whitespace
Context: ...aehr/open-research-data-template/issues) | | 📚 Docs Issue ...

---

Near line 122: Possible typo: you repeated a whitespace
Context: ...emplate/issues) | | 📚 Docs Issue | [GitHub Issue Tracker](https://github....

---

Near line 122: Possible typo: you repeated a whitespace
Context: ...aehr/open-research-data-template/issues) | | 🎁 Feature Requests ...

---

Near line 123: Possible typo: you repeated a whitespace
Context: ...e/issues) | | 🎁 Feature Requests | [GitHub Issue Tracker](https://github....

---

Near line 123: Possible typo: you repeated a whitespace
Context: ...aehr/open-research-data-template/issues) | | 🛡 **Report a security vulnerability...

---

Near line 124: Possible typo: you repeated a whitespace
Context: ...ility** | See SECURITY.md | | 💬 General Questions ...

---

Near line 125: Possible typo: you repeated a whitespace
Context: ... | | 💬 General Questions | [GitHub Discussions](https://github.co...

---

Near line 137: Possible spelling mistake found.
Context: ...ts. ## Authors and credits - Moritz Mähr - Initial work - [maehr](https://gi...

---

Near line 137: Unpaired symbol: ‘]’ seems to be missing
Context: ...s - Moritz Mähr - Initial work - maehr See al...

---

Near line 137: Possible spelling mistake found.
Context: ... - Moritz Mähr - Initial work - maehr See also th...

---

Near line 143: Possible spelling mistake found.
Context: ...is repository is released under the GNU Affero General Public License v3.0 - see the [...

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 1

Out of diff range and nitpick comments (1)

README.md (1)

Line range hint 3-3: There's a minor typo in the word "archiving" which should be corrected to maintain professionalism in documentation.

- long-term arc...
+ long-term archiving...