[codex] Add CITATION.cff - #91
Merged
Merged
Conversation
Version bump check ✅
Checked 1 group(s) against |
There was a problem hiding this comment.
🔵 Needs a closer look
Split the article page range into separate start and end fields in CITATION.cff.
Pull request overview
Adds structured citation metadata for GitHub/CFF consumers while preserving R package citation behavior and validating the metadata in CI.
Changes:
- Adds root
CITATION.cff. - Excludes it from R source tarballs.
- Adds a read-only schema-validation workflow.
File summaries
| File | Summary |
|---|---|
CITATION.cff |
Adds package and article citation metadata; the page range should use separate start and end fields. |
.Rbuildignore |
Excludes CITATION.cff from source tarballs. |
.github/workflows/validate-citation-cff.yml |
Validates CFF syntax and schema. |
Review details
Suppressed comments (1)
CITATION.cff:49
startis the first-page field in CFF, not a pages-range field. Recording235-248here makes the whole range the start page and omits the end page, so structured consumers can render the preferred citation incorrectly. Split the range into separatestartandendvalues.
start: 235-248
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
GitHub cannot presently discover structured citation metadata for this R package. This pull request adds a root
CITATION.cff, preserves the repository's existing citation preference, excludes the repository-only file from the R source tarball, and adds a read-only schema-validation workflow.The existing
inst/CITATIONremains authoritative forcitation(); the new CFF enables GitHub and other CFF consumers without changing package behavior.Validated with
cffconvert --validate,cffr::cff_validate(), andR CMD build --no-build-vignettes; the source tarball excludesCITATION.cff.Note: This pull request was prepared by GPT-5.6 Terra on behalf of gvegayon.