Contributing to groundmeas

We welcome contributions. Follow these steps to set up a local development environment.

Development setup

1. Clone the repository:

   git clone https://github.com/Ce1ectric/groundmeas.git
   cd groundmeas
   

2. Install dependencies (Poetry):

   poetry install
   

3. Activate the environment:

   poetry shell
   

Running tests

We use pytest.

pytest

Building documentation

We use MkDocs with the Read the Docs theme and mkdocstrings.

1. Install doc dependencies:

   poetry add -D mkdocs mkdocstrings[python]
   

2. Serve documentation locally:

   mkdocs serve
   

3. Build the static site:

   mkdocs build
   

Release process

Use the included script to release a new version:

python scripts/release.py