From 47ef65e1c5873d82f54928cbfafc6ff8892322a5 Mon Sep 17 00:00:00 2001 From: Tarunya K Date: Sat, 20 Jun 2026 13:29:38 +0530 Subject: [PATCH] docs: add contributor workflow diagram to README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 0752b11..e4d5a44 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,49 @@ We have set up templates to help you raise clean and structured Issues and Pull Thanks to all the amazing people who contribute to **DevEvent_Tracker** 🚀 +### Contribution Workflow + +Below is the step-by-step workflow for contributing to this project. Please make sure to follow the guidelines detailed in our [Contributing Guidelines](docs/CONTRIBUTING.md). + +```mermaid +flowchart TD + Start([Start]) --> FindIssue{Choose Path} + + FindIssue -->|Find Existing Issue| Comment["Comment on Issue requesting assignment"] + FindIssue -->|Found a Bug / Have Idea| CreateIssue["Create Issue (using Bug/Feature Template)"] + + CreateIssue --> Approved{Issue Approved?} + Approved -->|Yes| Comment + Approved -->|No| Close["Issue Closed"] + + Comment --> Assigned{Assigned to you?} + Assigned -->|Yes| Fork["Fork & Clone Repository"] + Assigned -->|No / Limit Exceeded| Comment + + Fork --> Branch["Create Branch (feature/..., fix/..., docs/...)"] + Branch --> Develop["Develop & Test Locally"] + Develop --> Commit["Commit using Semantic Commits (feat:, fix:, docs:)"] + Commit --> Sync["Sync with upstream main & Resolve conflicts"] + Sync --> Push["Push to your Fork"] + Push --> PR["Open PR (using Template & link Issue)"] + + PR --> Review{Code Review} + Review -->|Revisions Requested| Fix["Address Revisions & Push"] + Fix --> Review + Review -->|Approved| SSOC["SSOC Label Added"] + SSOC --> Merge([PR Merged! 🎉]) + + classDef startEnd fill:#10B981,stroke:#059669,stroke-width:2px,color:#fff; + classDef step fill:#1E293B,stroke:#475569,stroke-width:1.5px,color:#F8FAF5; + classDef decision fill:#3B82F6,stroke:#2563EB,stroke-width:2px,color:#fff; + classDef stop fill:#EF4444,stroke:#DC2626,stroke-width:2px,color:#fff; + + class Start,Merge startEnd; + class Comment,CreateIssue,Fork,Branch,Develop,Commit,Sync,Push,PR,Fix,SSOC step; + class FindIssue,Approved,Assigned,Review decision; + class Close stop; +``` +

Contributors