Skip to content

Conversation

@dolliecoder
Copy link

@dolliecoder dolliecoder commented Feb 3, 2026

Fixes #208

The README referenced a CONTRIBUTING.md file that did not exist, causing a 404 error when clicked.

Added a simple contribution guide to help new contributors understand:

  • how to set up the project
  • development workflow
  • running tests
  • submitting pull requests

This ensures the README link works correctly and improves onboarding for contributors.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contributor guidelines including setup instructions and development environment requirements to help new contributors get started with the project.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 3, 2026

Warning

Rate limit exceeded

@dolliecoder has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 46 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

A new contributor documentation file is added to the DevR.AI repository containing welcome messaging, contribution guidelines, and setup instructions for contributors, directly addressing the missing CONTRIBUTOR.md file referenced in the README.

Changes

Cohort / File(s) Summary
Contributor Documentation
CONTRIBUTOR.md
New file added with welcome message, contribution scope, and Getting Started section with fork/clone/environment setup instructions and pip installation command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A contributor's guide has come to stay,
With fork and clone to light the way,
Install, create, and join our crew—
We're hopping forward, thanks to you! 🚀

🚥 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: adding a missing CONTRIBUTING.md file to fix the broken README link referenced in issue #208.
Linked Issues check ✅ Passed The PR addresses the primary objective of issue #208 by adding a CONTRIBUTING.md file with contribution guidance, fixing the 404 error from the broken README link.
Out of Scope Changes check ✅ Passed All changes are in scope: the PR adds only CONTRIBUTOR.md with contribution setup guidance as required by issue #208, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@CONTRIBUTOR.md`:
- Around line 1-16: The new file is named CONTRIBUTOR.md but the project and
README expect CONTRIBUTING.md, causing the broken README link; fix by either
renaming CONTRIBUTOR.md to CONTRIBUTING.md (so file name matches expected
CONTRIBUTING.md) or update the README markdown link that references
CONTRIBUTING.md to point to CONTRIBUTOR.md; ensure the symbol names
CONTRIBUTOR.md and CONTRIBUTING.md are consistently used so the README link
resolves.

@dolliecoder
Copy link
Author

dolliecoder commented Feb 4, 2026

@smokeyScraper Hi! Just a gentle ping. I’ve addressed the changes and would appreciate a review when you have time. Thanks 🙂

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.

BUG: Broken link to CONTRIBUTING.md results in 404 error

1 participant