Skip to content

[DOCS] Add CONTRIBUTING.md with setup guide, branch naming, and PR checklist #969

@Priyanshu-byte-coder

Description

@Priyanshu-byte-coder

Problem Statement

There is no CONTRIBUTING.md file. New contributors (especially GSSoC participants) have no documented process for: forking, branch naming, commit message style, running the project locally, or what to include in a PR. This leads to inconsistent PRs and repeated review feedback.

Proposed Solution

Create CONTRIBUTING.md at the repo root with:

  1. Local setup — clone, install, env vars, npm run dev
  2. Branch namingfeat/<description>, fix/<description>, docs/<description>
  3. Commit messages — Conventional Commits format
  4. PR checklist — runs without errors, no console warnings, screenshots for UI changes
  5. Code style — ESLint/Prettier config, no unused imports
  6. Issue claiming — comment on issue before starting work

Acceptance Criteria

  • CONTRIBUTING.md created at repo root
  • Local setup steps work end-to-end for a fresh clone
  • Branch naming convention documented
  • PR checklist included
  • Link from README to CONTRIBUTING.md

Additional Context

This is especially important for GSSoC — most participants are making their first open source contribution. Clear guidelines reduce maintainer review burden significantly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationlevel:beginnerGSSoC: Beginner difficulty (20 pts)needs-triageNeeds maintainer triagetype:docsGSSoC type bonus: documentation (+5 pts)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions