Skip to content

docs: add contribution workflow section to README#9

Open
SANDHIYAPRIYADHARSHINI wants to merge 1 commit into
Abhash-Chakraborty:mainfrom
SANDHIYAPRIYADHARSHINI:docs/contribution-workflow-section
Open

docs: add contribution workflow section to README#9
SANDHIYAPRIYADHARSHINI wants to merge 1 commit into
Abhash-Chakraborty:mainfrom
SANDHIYAPRIYADHARSHINI:docs/contribution-workflow-section

Conversation

@SANDHIYAPRIYADHARSHINI
Copy link
Copy Markdown

@SANDHIYAPRIYADHARSHINI SANDHIYAPRIYADHARSHINI commented May 12, 2026

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

  • Bug fix
  • Feature
  • Documentation update
  • Refactor
  • CI / tooling

What changed

  • Added "Contribution Workflow" section to README.md
  • Included step-by-step flow with commands for frontend and backend checks
  • Added links to CONTRIBUTING.md and issue labels

Screenshots / recordings (for UI changes)

Attach before/after screenshots or a short video.

How to test

  1. Open README.md on GitHub
  2. Scroll to "Contribution Workflow" section
  3. Verify the flow is readable and commands match repo setup
  4. Verify all links work correctly

Checklist

  • I linked the related issue
  • I ran required checks from CONTRIBUTING.md
  • I updated docs/env notes if needed
  • My PR is scoped to a single issue
  • I followed commit message conventions
  • I am not committing secrets or local artifacts

GSSoC'26 checklist

  • I requested issue assignment before starting
  • I have meaningful commits (no spam commits)
  • I am ready to explain my implementation in review comments

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with a comprehensive step-by-step workflow for new contributors.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

📝 Walkthrough

Walkthrough

The 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.

Changes

Contribution Workflow Documentation

Layer / File(s) Summary
Contribution Workflow section
README.md
Replaces "Contribution quick start" with a detailed "Contribution Workflow" section containing an ordered workflow (find issue, get assigned, fork/branch, make changes, run quality checks, commit/push, open PR with issue link, await review), followed by pointers to CONTRIBUTING.md and key issue labels.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Abhash-Chakraborty/Find#8: Updates README's contributor guidance by replacing prior "Contribution quick start" with a new step-by-step contribution workflow section.

Poem

🐰 A contributor's path now shines so clear,
Step by step, no need to fear!
Fork and branch, then check with care,
Open PR and find us there!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—adding a contribution workflow section to the README.
Linked Issues check ✅ Passed The PR addresses issue #5 by adding a contribution workflow section to README.md with step-by-step flow, command snippets, and links to CONTRIBUTING.md and labels as required.
Out of Scope Changes check ✅ Passed All changes are scoped to the contribution workflow documentation in README.md; no unrelated modifications are present outside the stated objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description comprehensively follows the template with all required sections completed, including summary, type of change, what changed, how to test, and both checklists.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

Copy link
Copy Markdown

@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

🤖 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 713f25f6-295f-4f4c-9b36-453616a860c2

📥 Commits

Reviewing files that changed from the base of the PR and between 54b1c3d and fe928bb.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@Abhash-Chakraborty
Copy link
Copy Markdown
Owner

@SANDHIYAPRIYADHARSHINI GSSoC'26 leaderboard starts from 15th May, so this may not count if merged before that.

@Abhash-Chakraborty Abhash-Chakraborty added documentation Improvements or additions to documentation good first issue Good for newcomers gssoc26 GSSoC'26 program issue level 1 Beginner-friendly, small scoped task labels May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers gssoc26 GSSoC'26 program issue level 1 Beginner-friendly, small scoped task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add contribution workflow visual in README

2 participants