Skip to content

Update README.md#11849

Open
RitikaSen27 wants to merge 1 commit intopubliclab:mainfrom
RitikaSen27:patch-1
Open

Update README.md#11849
RitikaSen27 wants to merge 1 commit intopubliclab:mainfrom
RitikaSen27:patch-1

Conversation

@RitikaSen27
Copy link
Copy Markdown

@RitikaSen27 RitikaSen27 commented Jan 18, 2026

Improve README onboarding for first-time contributors

Fixes #11846

This PR improves the README.md to make onboarding easier for first-time contributors.
It adds a quick start section, a high-level architecture overview, and clarifies local setup guidance.

I have added a screenshot of the changes made in the README file below:

readme update1 readme update2

Improve README onboarding for first-time contributors
@RitikaSen27
Copy link
Copy Markdown
Author

Screenshots added.

This is a documentation-only PR (README.md), and the CI failures appear unrelated to these changes.
Thank you for the review!

@tarunashri6
Copy link
Copy Markdown

Hi! I reviewed this PR.
The added "Quick Start for New Contributors" section is very helpful and improves onboarding for beginners. The instructions are clear and easy to follow.
Great work! 😊

@RitikaSen27
Copy link
Copy Markdown
Author

Thank you for the review!
Kindy Let me know if there is anything else i can work on.

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.

Improve README.md and CONTRIBUTING.md for better newcomer onboarding

2 participants