-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Various fixes #18
Various fixes #18
Conversation
WalkthroughThe recent updates revolve around enhancing license management and presentation for a GitHub repository dedicated to open research data. Changes include configuring website settings in Quarto, updating license files and badges, and adding a new step in the GitHub workflow for proper setup before publishing. Changes
Poem` → `[![DOI](https://zenodo.org/badge/ZENODO_RECORD.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD)` README.template.md: ## Short Summary Alterations to the declarations of exported or public entities
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
package.json
is excluded by!**/*.json
pnpm-lock.yaml
is excluded by!pnpm-lock.yaml
,!**/*.yaml
Files selected for processing (5)
- .github/_quarto.yml (1 hunks)
- .github/labeler.yml (1 hunks)
- .github/workflows/quarto-publish.yml (1 hunks)
- README.md (2 hunks)
- README.template.md (1 hunks)
Files skipped from review due to trivial changes (3)
- .github/_quarto.yml
- .github/labeler.yml
- .github/workflows/quarto-publish.yml
Additional Context Used
LanguageTool (35)
README.md (30)
Near line 17: Unpaired symbol: ‘]’ seems to be missing
Context: ... and encourage collaboration - Increase security - Follow accepted [...
Near line 18: Unpaired symbol: ‘]’ seems to be missing
Context: ...security - Follow accepted ethics ## How this template h...
Near line 25: Unpaired symbol: ‘]’ seems to be missing
Context: .../)) - Automatic long-term archiving via Zenodo - Licensed ...
Near line 26: Unpaired symbol: ‘]’ seems to be missing
Context: ...](LICENSE-CCBY.md) license according to [The Turing Way](https://the-turing-way.n...
Near line 32: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) according to [keepachangelog.com](https://keepachangel...
Near line 34: Unpaired symbol: ‘]’ seems to be missing
Context: ...iff) - package.json via [npm docs](https://docs.npmjs.com/cli/v7/...
Near line 35: Unpaired symbol: ‘]’ seems to be missing
Context: ...publishing-source-for-github-pages) and Quarto ### Consis...
Near line 39: Unpaired symbol: ‘]’ seems to be missing
Context: ...onsistency - Consistent formatting via Prettier - Consis...
Near line 40: Unpaired symbol: ‘]’ seems to be missing
Context: ...conventionalcommits.org/en/v1.0.0/) via [husky](https://github.com/typicode/husky...
Near line 41: Unpaired symbol: ‘]’ seems to be missing
Context: ...code/husky) - Consistent versioning via [Semantic Versioning](https://semver.org/...
Near line 42: Unpaired symbol: ‘]’ seems to be missing
Context: ...r324/ce0505fbed06b947d962) workflow via [GitHub branch protection](https://docs.g...
Near line 43: Unpaired symbol: ‘]’ seems to be missing
Context: ...rotection-rule) - Consistent issues via [issue templates](https://docs.github.com...
Near line 44: Unpaired symbol: ‘]’ seems to be missing
Context: ...y) - Consistent pull request labels via [labeler](https://github.com/actions/labe...
Near line 49: Unpaired symbol: ‘]’ seems to be missing
Context: ...urity - SECURITY.md per [GitHub](https://docs.github.com/en/code-...
Near line 49: Possible typo: you repeated a word
Context: ...rity - SECURITY.md per GitHub - [GitHub Security Alerts](https://github.blog/20...
Near line 55: Unpaired symbol: ‘]’ seems to be missing
Context: ...CONDUCT.md](CODE_OF_CONDUCT.md) per the [Contributor Covenant](https://www.contri...
Near line 56: Unpaired symbol: ‘]’ seems to be missing
Context: ...g/) - Friendly initial interactions via [Greetings](https://github.com/actions/st...
Near line 71: Unpaired symbol: ‘]’ seems to be missing
Context: ...emplate for your project: - [ ] enable [GitHub security alerts](https://github.b...
Near line 73: Unpaired symbol: ‘]’ seems to be missing
Context: ...EADME.template.md](README.template.md), SECURITY.md - [ ] setup th...
Near line 74: Unpaired symbol: ‘]’ seems to be missing
Context: ...CURITY.md](SECURITY.md) - [ ] setup the [Zenodo integration](https://docs.github....
Near line 75: Unpaired symbol: ‘]’ seems to be missing
Context: ...g-content) - [ ] addZENODO_RECORD
to README.md - [ ] add favicons...
Near line 76: Unpaired symbol: ‘]’ seems to be missing
Context: ...d) - [ ] add favicons to./
, e.g. via favicon.io - [ ] s...
Near line 78: Unpaired symbol: ‘]’ seems to be missing
Context: ... documentation) and fix it - [ ] delete README.md - [ ] rename [READ...
Near line 79: Unpaired symbol: ‘]’ seems to be missing
Context: ...DME.template.md](README.template.md) to README.md - [ ] run `npm run...
Near line 82: Unpaired symbol: ‘]’ seems to be missing
Context: ...un changelog` and include the output in CHANGELOG.md - [ ] enable...
Near line 83: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/art...
Near line 84: Unpaired symbol: ‘]’ seems to be missing
Context: ... - [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites...
Near line 88: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add aCITATION.CFF
according to [citation-file-format.github.io](https://...
Near line 89: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add a.zenodo.json
according to [zenodo.org](https://developers.zenodo.or...
Near line 140: Unpaired symbol: ‘]’ seems to be missing
Context: ...s - Moritz Mähr - Initial work - maehr See al...README.template.md (5)
Near line 16: Loose punctuation mark.
Context: ... is organized as follows: -analysis/
: scripts and notebooks used to analyze t...
Near line 22: Loose punctuation mark.
Context: ...ing notes, project plans, etc.) -src/
: source code for the data (e.g., scripts...
Near line 30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the data and is part of the products. - TODO All rights and intellectual property is...
Near line 34: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ns, GNU, BSD, MPL). ## Use These data are openly available to everyone and can be...
Near line 79: Unpaired symbol: ‘]’ seems to be missing
Context: ...ment - FULLNAME - Initial work - USERNAME ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/labeler.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/labeler.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
pnpm-lock.yaml
is excluded by!pnpm-lock.yaml
,!**/*.yaml
Files selected for processing (2)
- .github/workflows/quarto-publish.yml (1 hunks)
- README.md (3 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/quarto-publish.yml
Additional Context Used
LanguageTool (29)
README.md (29)
Near line 18: Unpaired symbol: ‘]’ seems to be missing
Context: ... and encourage collaboration - Increase security - Follow accepted [...
Near line 19: Unpaired symbol: ‘]’ seems to be missing
Context: ...security - Follow accepted ethics ## How this template h...
Near line 26: Unpaired symbol: ‘]’ seems to be missing
Context: .../)) - Automatic long-term archiving via Zenodo - Licensed ...
Near line 27: Unpaired symbol: ‘]’ seems to be missing
Context: ...](LICENSE-CCBY.md) license according to [The Turing Way](https://the-turing-way.n...
Near line 33: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) according to [keepachangelog.com](https://keepachangel...
Near line 35: Unpaired symbol: ‘]’ seems to be missing
Context: ...iff) - package.json via [npm docs](https://docs.npmjs.com/cli/v7/...
Near line 36: Unpaired symbol: ‘]’ seems to be missing
Context: ...publishing-source-for-github-pages) and Quarto ### Consis...
Near line 40: Unpaired symbol: ‘]’ seems to be missing
Context: ...onsistency - Consistent formatting via Prettier - Consis...
Near line 41: Unpaired symbol: ‘]’ seems to be missing
Context: ...conventionalcommits.org/en/v1.0.0/) via [husky](https://github.com/typicode/husky...
Near line 42: Unpaired symbol: ‘]’ seems to be missing
Context: ...code/husky) - Consistent versioning via [Semantic Versioning](https://semver.org/...
Near line 43: Unpaired symbol: ‘]’ seems to be missing
Context: ...r324/ce0505fbed06b947d962) workflow via [GitHub branch protection](https://docs.g...
Near line 44: Unpaired symbol: ‘]’ seems to be missing
Context: ...rotection-rule) - Consistent issues via [issue templates](https://docs.github.com...
Near line 49: Unpaired symbol: ‘]’ seems to be missing
Context: ...urity - SECURITY.md per [GitHub](https://docs.github.com/en/code-...
Near line 49: Possible typo: you repeated a word
Context: ...rity - SECURITY.md per GitHub - [GitHub Security Alerts](https://github.blog/20...
Near line 55: Unpaired symbol: ‘]’ seems to be missing
Context: ...CONDUCT.md](CODE_OF_CONDUCT.md) per the [Contributor Covenant](https://www.contri...
Near line 56: Unpaired symbol: ‘]’ seems to be missing
Context: ...g/) - Friendly initial interactions via [Greetings](https://github.com/actions/st...
Near line 71: Unpaired symbol: ‘]’ seems to be missing
Context: ...emplate for your project: - [ ] enable [GitHub security alerts](https://github.b...
Near line 73: Unpaired symbol: ‘]’ seems to be missing
Context: ...EADME.template.md](README.template.md), SECURITY.md - [ ] setup th...
Near line 74: Unpaired symbol: ‘]’ seems to be missing
Context: ...CURITY.md](SECURITY.md) - [ ] setup the [Zenodo integration](https://docs.github....
Near line 75: Unpaired symbol: ‘]’ seems to be missing
Context: ...g-content) - [ ] addZENODO_RECORD
to README.md - [ ] add favicons...
Near line 76: Unpaired symbol: ‘]’ seems to be missing
Context: ...d) - [ ] add favicons to./
, e.g. via favicon.io - [ ] s...
Near line 78: Unpaired symbol: ‘]’ seems to be missing
Context: ... documentation) and fix it - [ ] delete README.md - [ ] rename [READ...
Near line 79: Unpaired symbol: ‘]’ seems to be missing
Context: ...DME.template.md](README.template.md) to README.md - [ ] run `npm run...
Near line 82: Unpaired symbol: ‘]’ seems to be missing
Context: ...un changelog` and include the output in CHANGELOG.md - [ ] enable...
Near line 83: Unpaired symbol: ‘]’ seems to be missing
Context: ...HANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/art...
Near line 84: Unpaired symbol: ‘]’ seems to be missing
Context: ... - [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites...
Near line 88: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add aCITATION.CFF
according to [citation-file-format.github.io](https://...
Near line 89: Unpaired symbol: ‘]’ seems to be missing
Context: ...- [ ] add a.zenodo.json
according to [zenodo.org](https://developers.zenodo.or...
Near line 140: Unpaired symbol: ‘]’ seems to be missing
Context: ...s - Moritz Mähr - Initial work - maehr See al...
Additional comments not posted (2)
README.md (2)
8-9
: The updates to the license badges are aligned with the new licensing structure. Ensure that the placeholdersUSERNAME
andREPO_NAME
are replaced with actual values.
11-11
: Ensure the placeholderZENODO_RECORD
in the DOI badge is replaced with an actual DOI record.
Pull request
Proposed changes
Types of changes
Checklist