Skip to content

Conversation

@Riya-singh339
Copy link

@Riya-singh339 Riya-singh339 commented Dec 24, 2025

This PR adds a beginner-friendly "Getting Started" section to the README
to help new contributors understand how to begin contributing.

Changes:

  • Added clear steps for first-time contributors
  • Improved onboarding clarity

Please let me know if any changes are required.

Summary by CodeRabbit

  • Documentation
    • Added a "Getting Started for Beginners" section to the README with a concise four-step onboarding flow to help new contributors: read the guide, follow contribution/setup instructions, run the project locally, and seek beginner-friendly issues or docs improvements.

✏️ Tip: You can customize this high-level summary in your review settings.

Helps new contributors understand how to get started.
@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 24, 2025

📝 Walkthrough

Walkthrough

A new "Getting Started for Beginners" section is added to README.md, providing a four-step onboarding guide for new contributors. The section is positioned between the CONTRIBUTING.md reference and the Architecture section. This is a documentation-only addition with no code modifications.

Changes

Cohort / File(s) Summary
Documentation Update
README.md
Added "Getting Started for Beginners" section with a four-step guide: (1) Read README completely, (2) Follow setup in CONTRIBUTING.md, (3) Try running the project locally, (4) Look for beginner-friendly issues or documentation improvements. Inserted after CONTRIBUTING.md reference and before Architecture section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A carrot of welcome for those just starting out,
Four hoppy steps to chase your code-dreams about,
Read, setup, try, and leap into the fray,
New friends in the warren—hip-hop, hooray! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately reflects the main change: adding a beginner-friendly Getting Started section to the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5687585 and a9aacbd.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 917daff and 5687585.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🪛 LanguageTool
README.md

[grammar] ~19-~19: Ensure spelling is correct
Context: ...ginner-friendly issues or documentation improvments. # Architecture ### Frontend - **...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

1 similar comment
@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

@Riya-singh339
Copy link
Author

Riya-singh339 commented Dec 24, 2025 via email

@yugalkaushik
Copy link

@Riya-singh339 Thank you for the PR, All the mentioned in the PR are already properly defined in contribution.md file. So for now this change is not required, you can checkout other issues to work on.

@Riya-singh339
Copy link
Author

Riya-singh339 commented Dec 25, 2025 via email

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.

2 participants