docs: add contributors section to README#154
Conversation
📝 WalkthroughWalkthroughA new "Contributors" section is appended to ChangesREADME Contributors Section
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 Warning |
![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 `@README.md`:
- Around line 353-358: The Contributors badge in the README uses a hard-coded
repository reference (Devnil434/Eagle) in the contrib.rocks image URL, which is
inconsistent with the placeholder pattern established elsewhere in the document
(referenced at lines 211 and 385). Replace the hard-coded repository reference
in the contrib.rocks image URL with the same placeholder pattern used throughout
the README to ensure the badge correctly points to users' own repositories when
they fork or clone the project. Check lines 211 and 385 to identify the exact
placeholder pattern being used and apply it to the repository parameter in the
contrib.rocks URL.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ### 👥 Contributors | ||
|
|
||
| Thanks to all contributors ❤️ | ||
|
|
||
| [](https://github.com/Devnil434/Eagle/graphs/contributors) | ||
|
|
There was a problem hiding this comment.
Hard-coded repository reference breaks README template consistency.
The contrib.rocks badge uses a hard-coded repository reference (Devnil434/Eagle) while other parts of the README use the placeholder pattern (your-org). Lines 211 and 385 show the established pattern for template customization. This inconsistency will confuse users who fork or clone the repo and expect the Contributors badge to point to their own repository.
🔧 Proposed fix to use placeholder pattern
### 👥 Contributors
Thanks to all contributors ❤️
-[](https://github.com/Devnil434/Eagle/graphs/contributors)
+[](https://github.com/your-org/Eagle/graphs/contributors)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### 👥 Contributors | |
| Thanks to all contributors ❤️ | |
| [](https://github.com/Devnil434/Eagle/graphs/contributors) | |
| ### 👥 Contributors | |
| Thanks to all contributors ❤️ | |
| [](https://github.com/your-org/Eagle/graphs/contributors) |
🤖 Prompt for 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.
In `@README.md` around lines 353 - 358, The Contributors badge in the README uses
a hard-coded repository reference (Devnil434/Eagle) in the contrib.rocks image
URL, which is inconsistent with the placeholder pattern established elsewhere in
the document (referenced at lines 211 and 385). Replace the hard-coded
repository reference in the contrib.rocks image URL with the same placeholder
pattern used throughout the README to ensure the badge correctly points to
users' own repositories when they fork or clone the project. Check lines 211 and
385 to identify the exact placeholder pattern being used and apply it to the
repository parameter in the contrib.rocks URL.
|
@Devnil434 labels?? |
2 participants
Changes
This helps recognize and showcase project contributors.
closes #151
Summary by CodeRabbit