Contribution Guidelines

Thank you for your interest in contributing to shmessy.

Prerequisites

Before you start, make sure you have poetry installed on your machine. You can install it with this command:

pip install poetry

Also, make sure you have forked the repository and cloned your fork to your local machine.

To set up the project, navigate to the project directory and run these commands:

# Install the project dependencies
poetry install

# Install the pre-commit hooks
poetry run pre-commit install

To run the tests, use this command:

poetry run pytest

To run the linter, use this command:

poetry run pylint src