globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: contribution instructions improvements

Browse source
This commit is contained in:
Éloi Rivard 2024-11-07 11:59:00 +01:00
parent d60b798f68
commit 3c5ea2e6bb
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.rst
View file

@ -16,6 +16,11 @@ Development environment
----------------------- -----------------------
You can either run the demo locally or with docker. You can either run the demo locally or with docker.
The only tool required for local development is `uv`.
Make sure to have uv `installed on your computer <https://docs.astral.sh/uv/getting-started/installation/>`_
to be able to hack Canaille.
After having launched the demo you have access to several services: After having launched the demo you have access to several services:
- A canaille server at `localhost:5000 <http://localhost:5000>`_ - A canaille server at `localhost:5000 <http://localhost:5000>`_
@ -122,16 +127,16 @@ Everything must be green before patches get merged.
To test a specific backend you can pass ``--backend memory``, ``--backend sql`` or ``--backend ldap`` to pytest and tox. To test a specific backend you can pass ``--backend memory``, ``--backend sql`` or ``--backend ldap`` to pytest and tox.
The test coverage is 100%, patches won't be accepted if not entirely covered. You can check the The test coverage is 100%, patches won't be accepted if not entirely covered. You can check the
test coverage with ``uv run pytest --cov --cov-report=html`` or ``tox -e coverage -- --cov-report=html``. test coverage with ``uv run pytest --cov --cov-report=html`` or ``uv run tox -e coverage -- --cov-report=html``.
You can check the HTML coverage report in the newly created `htmlcov` directory. You can check the HTML coverage report in the newly created `htmlcov` directory.
Code style Code style
---------- ----------
We use `ruff <https://docs.astral.sh/ruff/>`_ along with other tools to format our code. We use `ruff <https://docs.astral.sh/ruff/>`_ along with other tools to format our code.
Please run ``tox -e style`` on your patches before submitting them. Please run ``uv run tox -e style`` on your patches before submitting them.
In order to perform a style check and correction at each commit you can use our In order to perform a style check and correction at each commit you can use our
`pre-commit <https://pre-commit.com/>`_ configuration with ``pre-commit install``. `pre-commit <https://pre-commit.com/>`_ configuration with ``uv run pre-commit install``.
Front Front
----- -----