docs: update README.md for clearer developer onboarding#39439
docs: update README.md for clearer developer onboarding#39439Rohit544 wants to merge 1 commit intoRocketChat:developfrom
Conversation
…idance - Added project badges (version, build, license, coverage) - Included Node.js v22.16.0+ and Deno requirements - Added a 'Beginner contributions' section with tips for newcomers - Improved accessibility with alt text for all images - Reformatted sections for better readability and organization
|
Looks like this PR is not ready to merge, because of the following issues:
Please fix the issues and try again If you have any trouble, please check the PR guidelines |
|
|
rohitoo seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
WalkthroughREADME.md accessibility and structure improvements including addition of alt attributes to image tags, reorganization of headings and separators, reflowing of content sections, and minor markup refinements without altering core content semantics. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 2 files
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
![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 the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 10-13: Replace the incorrect workflow badge URL in the README's
build badge image tag: find the img element whose src contains
"build_and_test.yml" and update that segment to "ci.yml" so the src becomes
".../github/actions/workflow/status/RocketChat/Rocket.Chat/ci.yml"; keep the
rest of the badge attributes (alt text and other badges) unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f0e9eb8a-8980-49d1-8371-b9b9d42fc9bc
📒 Files selected for processing (2)
README.mddocker-compose.yml
📜 Review details
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:09.561Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs for apps/meteor/app/api/server/v1 endpoints, maintainers prefer to avoid any logic changes; style-only cleanups (like removing inline comments) may be deferred to follow-ups to keep scope tight.
Learnt from: MartinSchoeler
Repo: RocketChat/Rocket.Chat PR: 37408
File: apps/meteor/client/views/admin/ABAC/useRoomAttributeOptions.tsx:53-69
Timestamp: 2025-11-10T19:06:20.146Z
Learning: In the Rocket.Chat repository, do not provide suggestions or recommendations about code sections marked with TODO comments. The maintainers have already identified these as future work and external reviewers lack the full context about implementation plans and timing.
Learnt from: ggazzo
Repo: RocketChat/Rocket.Chat PR: 35995
File: apps/meteor/app/api/server/v1/rooms.ts:1107-1112
Timestamp: 2026-02-23T17:53:18.785Z
Learning: In Rocket.Chat PR reviews, maintain strict scope boundaries—when a PR is focused on a specific endpoint (e.g., rooms.favorite), avoid reviewing or suggesting changes to other endpoints that were incidentally refactored (e.g., rooms.invite) unless explicitly requested by maintainers.
📚 Learning: 2025-11-10T19:06:20.146Z
Learnt from: MartinSchoeler
Repo: RocketChat/Rocket.Chat PR: 37408
File: apps/meteor/client/views/admin/ABAC/useRoomAttributeOptions.tsx:53-69
Timestamp: 2025-11-10T19:06:20.146Z
Learning: In the Rocket.Chat repository, do not provide suggestions or recommendations about code sections marked with TODO comments. The maintainers have already identified these as future work and external reviewers lack the full context about implementation plans and timing.
Applied to files:
README.md
🔇 Additional comments (6)
README.md (6)
2-2: Excellent accessibility improvement!Adding descriptive alt text to the logo image improves accessibility for screen reader users.
22-33: Well-structured platform overview section.The addition of the emoji heading, introductory text, reformatted feature list, and hero image with proper alt text significantly improves readability and accessibility.
47-56: Excellent addition for new contributors!This "Beginner Contributions" section directly addresses the PR objective of improving developer onboarding. The specific, actionable suggestions (fix typos, update setup instructions, improve guides) combined with the link to "good first issue" labels provide a clear pathway for newcomers to get started.
60-114: Consistent formatting improvements throughout.The addition of horizontal rules, emoji-enhanced headings, and improved section organization significantly enhances document readability and scannability. The explicit mention of support channels (line 103) is particularly helpful for new users seeking assistance.
42-42: No action needed—Deno is actually required.Deno is legitimately used in the
packages/apps-engine/deno-runtimecomponent, which provides a Deno-based runtime for executing Rocket.Chat Apps. The codebase includes adeno.jsoncconfiguration, multiple modules importing fromhttps://deno.land/(Deno standard library), and application code using Deno APIs (Deno.args,Deno.stdin,Deno.pid, etc.). The README requirement for "Latest stable version" is correct.> Likely an incorrect or invalid review comment.
41-41: The README accurately reflects the package.json configuration, which specifies Node.js 22.16.0. While this is not the current LTS version (v24.14.0 is as of March 2026), the README correctly documents the actual requirement. No changes needed.
| <img src="https://img.shields.io/github/v/release/RocketChat/Rocket.Chat?label=version" alt="GitHub release version"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/RocketChat/Rocket.Chat/build_and_test.yml" alt="Build Status"> | ||
| <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License"> | ||
| <img src="https://img.shields.io/codecov/c/github/RocketChat/Rocket.Chat/develop" alt="Code Coverage"> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify the build_and_test.yml workflow file exists
fd -t f "build_and_test.yml" .github/workflows/Repository: RocketChat/Rocket.Chat
Length of output: 48
🏁 Script executed:
fd -t f . .github/workflows/Repository: RocketChat/Rocket.Chat
Length of output: 692
🏁 Script executed:
head -20 .github/workflows/ci.ymlRepository: RocketChat/Rocket.Chat
Length of output: 383
Correct the build workflow badge URL — it references a non-existent workflow.
The badge currently points to build_and_test.yml, which doesn't exist in .github/workflows/. The main CI workflow is ci.yml. Update the badge URL to:
https://img.shields.io/github/actions/workflow/status/RocketChat/Rocket.Chat/ci.yml
The other badges (version, license, coverage) appear correct. The alt text is also appropriate across all badges.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 10 - 13, Replace the incorrect workflow badge URL in
the README's build badge image tag: find the img element whose src contains
"build_and_test.yml" and update that segment to "ci.yml" so the src becomes
".../github/actions/workflow/status/RocketChat/Rocket.Chat/ci.yml"; keep the
rest of the badge attributes (alt text and other badges) unchanged.
2 participants
Proposed changes
Describe the big picture of your changes here.
Motivation and Context
As a software engineer setting up the project, I noticed some areas in the README that could be clarified to improve the Developer Experience (DX) for new contributors.
Type of change
Checklist
Summary by CodeRabbit