Repository navigation
Finalize public release documentation and Zenodo citation - #7
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The first public release is archived on Zenodo, but the README and source citation did not expose its DOI or REUSE registration. Add the project DOI
10.5281/zenodo.23361126consistently to the README badge and citation,CITATION.cff, the durable BibTeX source, and the illustrative layout demo. Keep the generic manuscript DOI field empty so new papers do not inherit the template DOI. Regenerate the bibliography and preview assets from their sources.Explain that the project DOI covers all releases and retain concise template acknowledgment guidance, without a release-specific README section to maintain. Add the live REUSE badge and remove the private-repository exception that skipped workflow URL validation.
The public-repository audit found that shared standards release
v0.5.18contains an invalid nested Markdown Links workflow reference. That issue is addressed in SchmiedmayerLab/.github#42. This PR preserves the normal@v0.5dependency. The shared fix has been merged and released. Required check names, permissions, and all version-tag conventions are unchanged.Validation:
Repository audit: the active main ruleset requires all seven expected checks, an approval, resolved conversations, signed commits, and linear history; squash merge is enabled. Secret scanning, push protection, dependency security updates, and CodeQL are enabled. Existing approval/bypass settings were inspected without modification. CodeQL's four mutable-tag warnings remain under the requested version-tag policy. No release tag, archived Zenodo record, manuscript decision log, or downstream paper repository is changed by this PR.