Skip to content

Added contributor workflow section#51

Open
ANKIT-RAJ-PATEL wants to merge 1 commit into
Flamki:masterfrom
ANKIT-RAJ-PATEL:add-contributor-workflow
Open

Added contributor workflow section#51
ANKIT-RAJ-PATEL wants to merge 1 commit into
Flamki:masterfrom
ANKIT-RAJ-PATEL:add-contributor-workflow

Conversation

@ANKIT-RAJ-PATEL
Copy link
Copy Markdown

@ANKIT-RAJ-PATEL ANKIT-RAJ-PATEL commented May 23, 2026

Added a contributor workflow section to CONTRIBUTING.md explaining:

  • issue claiming
  • branch creation
  • commits
  • pushing changes
  • opening pull requests

Summary by CodeRabbit

  • Documentation
    • Added a "Contributor Workflow" section to the contribution guide with step-by-step instructions for claiming issues, forking the repository, creating branches, making commits, pushing changes, and opening pull requests. Includes command examples for common Git operations.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

@ANKIT-RAJ-PATEL is attempting to deploy a commit to the flamki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

This PR adds a new "Contributor Workflow" section to CONTRIBUTING.md that documents the complete contribution process. It includes numbered steps for claiming issues, forking the repository, creating feature branches, making commits, pushing changes, and opening pull requests, along with practical bash command examples.

Changes

Contributor Workflow Documentation

Layer / File(s) Summary
Contributor workflow steps and examples
CONTRIBUTING.md
New "Contributor Workflow" section outlines the complete contribution process with six numbered steps and embedded bash commands for branching, committing, and pushing changes.

Sequence Diagram(s)

No diagram needed—this is a documentation-only change without code interactions or state transitions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • #44 — Both changes modify CONTRIBUTING.md to document the contributor workflow (claiming issues, creating branches, opening PRs), so they are directly related.

Poem

A hop and a skip, a branch in the night,
A commit, a push, and a pull request in sight,
New contributors now know the way,
To help the project grow each day! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete; it lacks required validation checks and security checklist items specified in the repository's template. Complete the description by adding the Validation section with checkboxes (local commands, secrets verification, docs updates) and the full Checklist section.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding a contributor workflow section to the documentation.

✏️ 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.

@ANKIT-RAJ-PATEL ANKIT-RAJ-PATEL changed the title Added contributor workflow section ## Changes - added contributor workflow section in CONTRIBUTING.md - added issue claiming steps - added branch naming example - added PR linking instructions ## Validation - [x] Documentation updated - [x] Markdown formatting checked Closes #44 May 24, 2026
@ANKIT-RAJ-PATEL
Copy link
Copy Markdown
Author

Implemented the requested contributor workflow section in CONTRIBUTING.md. Please review. Thanks!

@ANKIT-RAJ-PATEL ANKIT-RAJ-PATEL changed the title ## Changes - added contributor workflow section in CONTRIBUTING.md - added issue claiming steps - added branch naming example - added PR linking instructions ## Validation - [x] Documentation updated - [x] Markdown formatting checked Closes #44 Added contributor workflow section May 24, 2026
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.

1 participant