CONTRIBUTING.md

Contribution Guidelines

Thank you for your interest in contributing to "my-pkg". # TODO: Remember to update the package name if it changes.

Prerequisites

Before you start, ensure that uv is installed on your machine. You can install it using the following command:

  pipx install uv

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

Setup

To set up the project, navigate to the project directory and execute the following command to install project dependencies:

  make

Testing and Code Checking

To run the tests, use the following command:

  make test

To verify code style and formatting, use this command:

  make check

To build the documentation, use this command:

  make doc