Update README.md #428
Update README.md #428
Conversation
WalkthroughThe changes made in this pull request involve updates to the Changes
Assessment against linked issues
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
❌ Deploy Preview for manageyourwaste failed. Why did it fail? →
|
|
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. 😊 |
1 similar comment
|
Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. 😊 |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
![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
🧹 Outside diff range and nitpick comments (2)
README.md (2)
78-84: Enhance the Contributors section content.While the section successfully adds contributor recognition, consider these improvements:
- Complete the thank you message with proper punctuation
- Add a brief description of how to become a contributor
- Consider consolidating or cross-referencing with the "Contributing" section below to avoid duplication
Here's a suggested improvement:
## Contributors -A huge thanks to all our contributors +A huge thanks to all our contributors who have helped shape this project! + +Want to see your name here? Check out our [Contributing](#contributing) section to get started. <a href="https://github.com/GarimaSingh0109/WasteManagment/graphs/contributors"> <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" /> </a>🧰 Tools
🪛 Markdownlint (0.35.0)
82-82: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Line range hint
168-179: Remove duplicate sections at the end of the file.The "Open Source Programs" and "Code of Conduct" sections are duplicated. They appear earlier in the document (around line 140) and again at the end.
Remove the duplicate sections at the end of the file to maintain document clarity and reduce maintenance overhead.
🧰 Tools
🪛 Markdownlint (0.35.0)
19-19: null
Link fragments should be valid(MD051, link-fragments)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md
82-82: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
README.md (1)
17-17: LGTM! Table of Contents update is well-structured.
The new "Contributors" entry is properly placed and maintains good document organization.
README.md
Outdated
| <a href="https://github.com/GarimaSingh0109/WasteManagment/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" /> | ||
| </a> |
There was a problem hiding this comment.
Add alt text to improve accessibility.
The contributors image is missing alt text, which is important for accessibility and when images fail to load.
Apply this fix:
<a href="https://github.com/GarimaSingh0109/WasteManagment/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" />
+ <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" alt="Project contributors" />
</a>📝 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.
| <a href="https://github.com/GarimaSingh0109/WasteManagment/graphs/contributors"> | |
| <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" /> | |
| </a> | |
| <a href="https://github.com/GarimaSingh0109/WasteManagment/graphs/contributors"> | |
| <img src="https://contrib.rocks/image?repo=GarimaSingh0109/WasteManagment" alt="Project contributors" /> | |
| </a> |
🧰 Tools
🪛 Markdownlint (0.35.0)
82-82: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
Issues Identification
Closes: #385
Description
Summary
As stated in the issue description I added a contributors section in the readme file
Details
I changes include the github profiles of all contributors
Types of Changes
Please check the boxes that apply
Checklist
Please check the boxes that apply
Screenshots
--
Summary by CodeRabbit
New Features
Documentation