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

CONTRIBUTING reformulation

Browse source
This commit is contained in:
Éloi Rivard 2022-11-15 15:15:16 +01:00
parent c64395b980
commit 44b7bb5787
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.rst
View file

@ -3,20 +3,22 @@ Contribute
Contributions are welcome!
Unit tests
----------
To run the tests, you just need to run `tox`. Everything must be green before patches get merged.
.. warning ::
On Debian or Ubuntu systems, the OpenLDAP `slapd` binary usage might be restricted by apparmor, and thus makes the test fail. This can be mitigated by removing apparmor restrictions on `slapd`.
On Debian or Ubuntu systems, the OpenLDAP `slapd` binary usage might be restricted by apparmor,
and thus makes the tests and the demo fail. This can be mitigated by removing apparmor restrictions
on `slapd`.
.. code-block:: console
sudo apt install --yes apparmor-utils
sudo aa-complain /usr/sbin/slapd
Unit tests
----------
To run the tests, you just need to run `tox`. Everything must be green before patches get merged.
Style
-----
@ -52,6 +54,6 @@ The documentation is generated when the tests run:
.. code-block:: console
tox
tox -e doc
The generated documentation is in `./build/sphinx/html/` directory.