Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (45 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 1.81 KB

Contributing to LabOne Q Applications Library

We welcome contributions. This document includes the basics to get you started in contributing to laboneq-applications.

First time setup procedure

  1. Fork the repository
  2. Create a new feature branch off of main branch
  3. Commit your changes
  4. Open a pull request
  5. Add a reviewer to your feature

Testing

To ensure proper code quality and style, the project runs certain tests before a pull request can be merged into main

The following tests are executed:

  • Tests
  • Linting
  • Examples are run in emulated mode

Project is managed using uv. You can get it from https://docs.astral.sh/uv/. Once you have that, you can create a virtual environment and activate it via:

uv sync && source .venv/bin/activate

!!! note

If you are using a shell different than bash, you need to source the
appropriate script. E.g. if you have fish, that would be
`.venv/bin/activate.fish`.

Tests

Each feature must be tested and the package used for testing is pytest.

Running the tests:

pytest

Linting

The project uses ruff for code linting and formatting The enforced rules are located in pyproject.toml.

Running ruff:

ruff check

Fix the errors until there is none. If you encounter lots of error, don't panic. You can either start fixing them file by file or error code by error code.

Documentation

Make sure that your code is documented.

The project follows Google style docstrings

For more information on how to build the documentation and inspect the outcome, see: Documentation