fix(citation): quote DOI string literal in CITATION.cff#1409
Conversation
📝 WalkthroughWalkthroughThe PR quotes the DOI in ChangesCitation metadata
Contributor documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 11-12: Replace the shell-unsafe <your-username> placeholder with
YOUR_GITHUB_USERNAME in the Quick Start clone command and add guidance to
substitute the contributor’s GitHub username. Apply this change in
CONTRIBUTING.md lines 11-12 and docs/contributing.md line 37, keeping both
contributor guides consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 6072e613-31b2-41fe-9e87-be51f3fb71bc
📒 Files selected for processing (3)
CITATION.cffCONTRIBUTING.mddocs/contributing.md
There was a problem hiding this comment.
Pull request overview
This PR updates repository metadata and contributor documentation. It primarily brings CITATION.cff into closer alignment with CFF/YAML string formatting expectations, and also adjusts contributing docs headings and clone instructions.
Changes:
- Quote the
doivalue inCITATION.cffas a string literal. - Update headings capitalization in contributing documentation.
- Change
git cloneinstructions inCONTRIBUTING.mdanddocs/contributing.mdto reference a user fork.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CITATION.cff |
Quotes the DOI field value. |
docs/contributing.md |
Updates a section heading and the setup clone command. |
CONTRIBUTING.md |
Updates quick-start heading and the clone command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Resolves the conflict created when opengeos#1407 and opengeos#1408 landed the contributor-guide changes this branch was stacked on. - Both conflicts were the clone placeholder. Kept main's `YOUR_GITHUB_USERNAME` over this branch's `<your-username>`: angle brackets are shell redirection operators, so the command failed on paste. - The branch now carries only the CITATION.cff DOI quoting, matching the PR title and description.
Description
This PR quotes the DOI string field in
CITATION.cff.Details
Quoted the DOI value ($\to$
doi: 10.5281/...doi: "10.5281/...") to adhere to standard CFF schema string representations.Summary by CodeRabbit