Skip to content

docs: add CONTRIBUTING.md #73

@j-kon

Description

@j-kon

The repository currently has no contribution guide. New contributors have to infer the development setup, PR process, and CI workflow from reading through existing commits and workflow files.

A CONTRIBUTING.md at the repo root would cover:

  • How to set up the local development environment (Rust toolchain, Dart/Flutter SDK, just commands)
  • How to regenerate bindings (scripts/generate_bindings.sh)
  • How to run tests (just test, integration test env vars)
  • PR guidelines (branch naming, commit style, what to expect from review)
  • How to run CI checks locally before pushing

This is especially important as the project approaches a 1.0 release and starts attracting more outside contributors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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