CONTRIBUTING.md

This document contains information about contributing to this repository. Please read it before contributing.

Setup Instructions

lanarky is built with Python 3.9 and managed by Poetry. Clone this repository and follow the steps below to get started.

Create conda environment:

conda create -n lanarky python=3.9 -y
conda activate lanarky

You can choose any other environment manager of your choice.

Install dependencies:

pip install poetry
poetry install

CI/CD

lanarky uses pre-commit to run code checks and tests before every commit. To install the pre-commit hooks, run the following commands:

poetry run pre-commit install