Skip to content

Add CONTRIBUTING.md to the repo #4

Description

@Navashub

Description

New contributors need clear guidance on how to fork, branch, commit, and open PRs. This is the file that makes the project feel like a real open source repo.

What to do

  • Create a CONTRIBUTING.md file at the root of the project
  • Include: how to fork and clone, branch naming convention, commit message format, a PR checklist, and how to pick an issue
  • Keep it friendly and beginner-accessible

Acceptance Criteria

  • CONTRIBUTING.md exists at the repo root
  • It covers: fork → clone → branch → commit → PR flow
  • Mentions the branch naming convention (feature/, fix/, docs/)
  • Includes a PR checklist

Note

A draft of this file is available in the repo discussion. Feel free to use it as a starting point and improve it.

Difficulty

🟢 Beginner — Good First Issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions