Skip to content

fix(citation): quote DOI string literal in CITATION.cff#1409

Merged
giswqs merged 4 commits into
opengeos:mainfrom
amir-rezaei:fix/citation-doi-string-quoting
Jul 25, 2026
Merged

fix(citation): quote DOI string literal in CITATION.cff#1409
giswqs merged 4 commits into
opengeos:mainfrom
amir-rezaei:fix/citation-doi-string-quoting

Conversation

@amir-rezaei

@amir-rezaei amir-rezaei commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Description

This PR quotes the DOI string field in CITATION.cff.

Details

Quoted the DOI value (doi: 10.5281/... $\to$ doi: "10.5281/...") to adhere to standard CFF schema string representations.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guides with clearer heading capitalization.
    • Revised setup instructions to use a contributor’s fork URL placeholder.
  • Chores
    • Corrected DOI formatting to ensure it is recognized as a valid string value.

Copilot AI review requested due to automatic review settings July 24, 2026 11:31
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The PR quotes the DOI in CITATION.cff and updates contributor documentation headings and clone commands to use contributor fork URLs.

Changes

Citation metadata

Layer / File(s) Summary
Quote DOI metadata
CITATION.cff
The DOI is represented as a quoted YAML string.

Contributor documentation

Layer / File(s) Summary
Update contributor guides
CONTRIBUTING.md, docs/contributing.md
Contributor headings use title case, and setup instructions clone from a <your-username> fork URL.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: copilot, giswqs

Poem

A bunny checks the DOI line,
Quotes it neat and fine.
Fork URLs now guide the way,
With tidy headings bright as day.
Hop, review, and merge hooray!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: quoting the DOI string literal in CITATION.cff.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 98ab48b and 79e3b49.

📒 Files selected for processing (3)
  • CITATION.cff
  • CONTRIBUTING.md
  • docs/contributing.md

Comment thread CONTRIBUTING.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 doi value in CITATION.cff as a string literal.
  • Update headings capitalization in contributing documentation.
  • Change git clone instructions in CONTRIBUTING.md and docs/contributing.md to 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.

Comment thread CITATION.cff
Comment thread docs/contributing.md Outdated
Comment thread CONTRIBUTING.md Outdated
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.
@giswqs
giswqs merged commit 81be72c into opengeos:main Jul 25, 2026
32 of 33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants