Skip to content

docs: Create CONTRIBUTING.md guide #9

@Mattis44

Description

@Mattis44

Description

Create a comprehensive CONTRIBUTING.md file to help new developers get started contributing to the project.

What to include

  1. Getting Started section

    • Clone and setup instructions
    • How to install dependencies
    • How to run tests locally
    • How to run the demo
  2. Development Workflow

    • Branch naming convention
    • Commit message format
    • Code style guidelines
    • Testing requirements
  3. Pull Request Process

    • How to create a PR
    • PR title/description format
    • Review process
    • Merge requirements
  4. Project Structure

    • Brief overview of key directories
    • Where different types of files belong
    • Component structure
  5. Resources

    • Links to relevant documentation
    • TypeScript guidelines
    • Testing library resources

Template Reference

You can reference: https://github.com/facebook/react/blob/main/CONTRIBUTING.md

Labels

good first issue, documentation, help wanted

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions