docs(readme): Revise maintainer and contributor sections - #223
Conversation
Updated maintainer list and improved contributor acknowledgment.
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME.md was updated with an inline notice about C++ library extraction work, maintainers now display as avatar-embedded links, and the Contributors & Credits section received more expressive messaging with simplified link references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
|
@Krasner, please let me know if you're okay with this. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 107-109: The maintainer avatar img tags in README.md lack alt
attributes; update each <img> element for the maintainers (the three avatar
image tags shown) to include a descriptive alt attribute (e.g., alt="Ryan
Millard avatar", alt="hjmillard avatar", alt="krasner avatar") so screen readers
can announce the images while preserving the existing link text; ensure you add
alt to each <img src="..."> tag in the listed links.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~113-~113: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2824 characters long)
Context: ...his project has been greatly appreciated! [
🪛 markdownlint-cli2 (0.18.1)
README.md
107-107: Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: Images should have alternate text (alt text)
(MD045, no-alt-text)
109-109: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (3)
README.md (3)
64-66: LGTM! Helpful context for contributors.The IMPORTANT notice effectively communicates ongoing architectural work and encourages repo watching. The messaging is clear and appropriately prominent.
113-113: LGTM! More expressive contributor acknowledgment.The revised wording is warmer and more personal, better expressing appreciation for contributor efforts.
117-117: LGTM! Simplified credits link.The consolidated link to the site's credits page is clearer and avoids redundancy.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
sorry missed that i had to review this |
No worries. |
Updated maintainer list and improved contributor acknowledgment.
📚 Documentation Pull Request
📌 What’s Being Documented
Updates to maintainers and contributors sections.
Add @Krasner and revise wording.
✍️ Changes
Add @Krasner and revise wording.
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.