Skip to content

Fix link to contribution guidelines in README#1855

Merged
frenck merged 1 commit intofrenck:mainfrom
fleaz:patch-1
Oct 24, 2025
Merged

Fix link to contribution guidelines in README#1855
frenck merged 1 commit intofrenck:mainfrom
fleaz:patch-1

Conversation

@fleaz
Copy link
Copy Markdown
Contributor

@fleaz fleaz commented Oct 15, 2025

The file was moved a while ago into the .github folder.

Summary by CodeRabbit

  • Documentation
    • Corrected links to the contribution guidelines to point to their updated location in the repository’s community area.
    • Improves navigation for contributors and reduces confusion from outdated references.
    • Enhances onboarding clarity and keeps documentation consistent with the current project structure.
    • No changes to features, behavior, interfaces, or error handling.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 15, 2025

Walkthrough

Updated two links in README.md to point from CONTRIBUTING.md at repo root to .github/CONTRIBUTING.md. No code or control-flow changes.

Changes

Cohort / File(s) Summary
Documentation links
README.md
Adjusted two contribution guideline links from CONTRIBUTING.md to .github/CONTRIBUTING.md; no logic or behavior affected.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny hops through docs so neat,
Nudging links with careful feet.
From root to .github they go,
Trails corrected, neat in a row.
Tap-tap paws, a gentle cheer—
“Contrib path’s right here!” 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly and accurately describes the primary change, namely updating the link to the contribution guidelines in the README, making it clear and specific without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64abd7c and 8b009d3.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~73-~73: The official name of this software platform is spelled with a capital “H”.
Context: ...ocument for our contribution guidelines. Thank you for being ...

(GITHUB)

🔇 Additional comments (1)
README.md (1)

72-74: Link update looks good

New path .github/CONTRIBUTING.md matches the relocated contribution guidelines. Thanks for keeping the docs accurate.


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 and usage tips.

@frenck frenck self-assigned this Oct 24, 2025
@frenck frenck added the documentation Solely about the documentation of the project. label Oct 24, 2025
Copy link
Copy Markdown
Owner

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @fleaz 👍

../Frenck

@frenck frenck merged commit ab25336 into frenck:main Oct 24, 2025
2 of 3 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 26, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Solely about the documentation of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants