Skip to content

Suggestion: Add a CONTRIBUTING.md File to project #9

@shubhranshu-sahu

Description

@shubhranshu-sahu

Why CONTRIBUTING.md is Important

Adding a CONTRIBUTING.md file will make it much easier for new contributors (like me) to get up to speed — from understanding the tech stack and project setup to submitting clean PRs. It reduces friction, boosts collaboration, and helps maintain code quality.

What a CONTRIBUTING.md Can Include

  • Prerequisites & Tech Stack Overview
    (Frontend / Backend / Database, etc.)
  • Project Setup
    • How to clone and set up the project locally
    • How to run the dev server or API locally
  • Contribution Workflow
    • Guidelines for creating issues
    • Steps for submitting Pull Requests
  • Code Standards
    • Code formatting and linting rules
  • Best Practices
    • Any project-specific conventions or workflows

Please add a suitable label and assign this issue to me.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions