Skip to content

Add CONTRIBUTING.md #39

@shirshanka

Description

@shirshanka

We don't have a CONTRIBUTING.md yet, which is one of the first things potential contributors look for. Several people have asked in issues/discussions how to get the dev environment set up.

Should cover:

  • Prerequisites (Python 3.11+, uv, Node 20+, pnpm)
  • How to get the dev environment running (make install, make dev or the equivalent manual steps)
  • How to run the test suite
  • Commit message format (we use conventional commits)
  • PR process

Most of the raw material is already in README.md under the Development section — this is more about surfacing it in the right place and filling in the gaps around testing and PR etiquette.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions