Skip to content

docs: add interactive contribution workflow diagram to README#113

Merged
TarunyaProgrammer merged 1 commit into
niharika-mente:mainfrom
TarunyaProgrammer:main
Jun 20, 2026
Merged

docs: add interactive contribution workflow diagram to README#113
TarunyaProgrammer merged 1 commit into
niharika-mente:mainfrom
TarunyaProgrammer:main

Conversation

@TarunyaProgrammer

@TarunyaProgrammer TarunyaProgrammer commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR adds a visual, step-by-step contribution flowchart using Mermaid to the Contributors section of the README.md.

Why we added this:

  • Visual Onboarding: While text guidelines are essential, a diagram provides an immediate, digestible overview of the lifecycle of a contribution.
  • SSOC Alignment: It visually clarifies the specific rules of the Social Summer of Code program (such as requesting assignments first, handling inactive claims, and waiting for the SSOC label).

How beginners will be helped:

  • Reduces Confusion: Beginners often struggle with when to start coding (e.g., coding before being assigned). This diagram explicitly shows that cloning and branching happen after assignment.
  • Git Cheat Sheet: It maps out the exact sequence of Git commands needed (Fork -> Branch -> Develop -> Semantic Commit -> Sync with Upstream -> Push -> Open PR).
  • Interactive Loops: It clearly displays loops like "Addressing Revisions" and "Requesting Assignment," showing them how to react if their PR or assignment needs updates.

Verification

  • Verified that the Mermaid syntax renders perfectly without syntax errors on GitHub.
  • Verified that the color-coded class definitions (startEnd, step, decision, stop) have high contrast and display correctly in both dark and light modes.

Summary by CodeRabbit

  • Documentation
    • Added a Contribution Workflow section with an embedded flowchart detailing the complete contribution process, including issue assignment, branching, local development, semantic commits, code review, revisions, and merge procedures.

@vercel

vercel Bot commented Jun 20, 2026

Copy link
Copy Markdown

@TarunyaProgrammer is attempting to deploy a commit to the niharika-mente's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 37d6bdf4-7c2b-458e-8100-3d6b2abba329

📥 Commits

Reviewing files that changed from the base of the PR and between d3734a4 and 47ef65e.

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

📝 Walkthrough

Walkthrough

A new "Contribution Workflow" section is added to README.md. It includes introductory text referencing the Contributing Guidelines and a Mermaid flowchart TD diagram that maps the end-to-end contribution process from issue selection through merge, with associated Mermaid style class definitions.

Changes

README Contribution Workflow

Layer / File(s) Summary
Contribution Workflow section and flowchart
README.md
Adds a ### Contribution Workflow heading, introductory prose, and a Mermaid flowchart TD diagram covering issue selection/creation, fork/branch setup, local development, semantic commits, upstream sync, PR creation, review loop, SSOC labeling, and merge, along with Mermaid style class definitions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the motivation, use cases, and verification steps, but lacks explicit answers to several template sections (Type of Change, Testing, and Checklist items). Clarify which Type of Change option applies (likely 'Documentation update'), confirm testing approach, and address the checklist items to fully comply with the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding an interactive contribution workflow diagram to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

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

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.

@TarunyaProgrammer TarunyaProgrammer self-assigned this Jun 20, 2026
@TarunyaProgrammer TarunyaProgrammer added the mentor/pa helpful contributions by mentors or pa for the contributors label Jun 20, 2026
@TarunyaProgrammer TarunyaProgrammer merged commit 352b809 into niharika-mente:main Jun 20, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mentor/pa helpful contributions by mentors or pa for the contributors

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant