summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
blob: 4e7b1bd50ee361dee029cdc76f0e854261694918 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Contributing Guidelines
=======================

Thank you for your interest! If you find a bug, want to suggest an improvement, or
just have a question, please send an email to ~eugenetriguba/public-inbox@lists.sr.ht
with a subject that starts with `[PATCH lirc]` for patches and `[lirc]` otherwise.

Getting Up & Running
--------------------

This project uses `uv <https://docs.astral.sh/uv/>`_ for the build system and dependency management.
To get started, you will want that installed on your system.

Once you've installed ``uv``, you can install the dependencies, this package, and go into the
virtual environment.

.. code-block:: bash

  $ uv sync --all-groups
  $ source .venv/bin/activate

From inside the virtual environment, we can work with the package and easily run the tasks for
this project such as ``task test`` and ``task lint`` that are in the ``pyproject.toml`` file.