Skip to content

contributing.md

Latest commit

 

History

History
38 lines (24 loc) · 1.18 KB

contributing.md

File metadata and controls

38 lines (24 loc) · 1.18 KB

Contributing Guidelines

We welcome contributions from the community! This guide will help you understand our contribution process and requirements.

Development guidelines

  1. Small PRs (blogpost)
  2. When fixing a bug, include a test that reproduces the issue in the same pull request (the test should fail without your changes)
  3. If you are refactoring, ensure adequate test coverage exists for the target area. If coverage is insufficient, create tests in a separate pull request first. This approach provides a safety net for validating current behavior and simplifies code reviews.

Build and Test

Prerequisites:

Install dependencies

poetry install

Unit tests

poetry run pytest tests/unit

Linting and Type-checking

solnlib uses the pre-commit framework for linting and type-checking. Consult with pre-commit documentation about what is the best way to install the software.

To run it locally:

pre-commit run --all-files