docs: add contribution workflow section to README#9
Conversation
📝 WalkthroughWalkthroughThe README's contribution guidance was updated by replacing prior quick-start content with a new "Contribution Workflow" section. The new section provides a step-by-step workflow for first-time contributors, including issue discovery, branching, quality checks, and PR submission, along with references to CONTRIBUTING.md and issue labels. ChangesContribution Workflow Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 182-185: The backend quality-check step only runs "uv run ruff
check ." but the docs require both lint and format checks; update the workflow
step under "Run quality checks" to run both "uv run ruff format --check ." and
"uv run ruff check ." (preserving order) so it matches the README's "Local
quality checks" section and prevents contributors from skipping the format
check.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
@SANDHIYAPRIYADHARSHINI GSSoC'26 leaderboard starts from 15th May, so this may not count if merged before that. |
Summary
Adds a visual contribution workflow section to README.md to help
first-time contributors understand the end-to-end process from
picking an issue to getting a PR merged.
Fixes #5
Type of change
What changed
Screenshots / recordings (for UI changes)
Attach before/after screenshots or a short video.
How to test
Checklist
GSSoC'26 checklist
Summary by CodeRabbit