docs: fix Title Case section heading and fork clone URL placeholder in CONTRIBUTING.md#1407
Conversation
…n CONTRIBUTING.md
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughContributor documentation now directs users to fork GeoLibre and clone their fork, while the main guide’s “Quick Start” heading uses updated capitalization. ChangesContributor Setup Documentation
Estimated code review effort: 1 (Trivial) | ~2 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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: Update the Quick Start clone command in CONTRIBUTING.md to
replace the angle-bracket placeholder with a shell-safe placeholder such as
YOUR_GITHUB_USERNAME, and explicitly instruct readers to substitute it with
their GitHub username.
🪄 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: b593a8a1-baf1-4937-b050-242280f4f5dd
📒 Files selected for processing (1)
CONTRIBUTING.md
There was a problem hiding this comment.
Pull request overview
This PR updates CONTRIBUTING.md to improve contributor-facing documentation by standardizing a section heading’s Title Case and adjusting the example git clone command to reference a fork rather than the upstream repository.
Changes:
- Updated the “Quick start” heading to “Quick Start”.
- Replaced the example clone URL to use a user fork placeholder instead of the upstream org.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Replace the `<your-username>` clone placeholder with the shell-safe `YOUR_GITHUB_USERNAME`: angle brackets are redirection operators, so copy/pasting the Quick Start command failed in bash/zsh before `git clone` ran (CodeRabbit, Copilot). - Add a sentence above the block telling readers to fork first and substitute their GitHub username, so the placeholder is explicit (CodeRabbit).
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-15: Align the repository setup instructions between
CONTRIBUTING.md and docs/contributing.md so both direct contributors to the same
clone workflow. Update the linked guide to use the fork-based URL, or clearly
designate one document as canonical and link to it, eliminating conflicting
instructions.
🪄 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: 085de5b5-49a2-47d2-9e04-267973796687
📒 Files selected for processing (1)
CONTRIBUTING.md
- Align docs/contributing.md with CONTRIBUTING.md: the canonical guide still cloned opengeos/GeoLibre directly while the root file now tells contributors to clone their fork, so the two gave conflicting setup steps. Both now use the fork-based clone with the shell-safe YOUR_GITHUB_USERNAME placeholder.
…e-url Resolves the conflict created when opengeos#1407 merged the same CONTRIBUTING.md change ahead of this branch. - 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, which both Copilot and CodeRabbit flagged on opengeos#1407. - Kept this branch's `## Ways to Contribute` heading, the only change here not already on main. - Replaced the em dash in the fork sentence with a period in both files.
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 updates section heading Title Case formatting and fixes the git clone URL placeholder in
CONTRIBUTING.md.Details
## Quick start## Quick Start).opengeos<your-username>).Summary by CodeRabbit
YOUR_GITHUB_USERNAMEplaceholder.