Skip to content

Add a contribution guide #31

Description

@will-langdale

I've been working through a few issues in the repo and it'd be quite useful to have a small CONTRIBUTING.md to help me get started. Knowing your conventions, prerequisites etc would have saved me a bit of time. Things like:

  • A python venv inside py_maplib with the requirements in pt_maplib/tests/requirements.txt is important for pytest
  • Some Rust dependencies require the nightly build of Rust (rustup install nightly)

It would also be helpful to have something like ruff in the mix to enforce your style rules.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions