sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update contributing instructions

Browse source
This commit is contained in:
Hugo Osvaldo Barrera 2020-06-09 10:42:26 +02:00
parent 50eefa1816
commit af3659ac1a
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/contributing.rst
View file

@ -84,8 +84,8 @@ virtualenv_ and run this inside of it::
# - stylecheckers (flake8) and code formatters (autopep8)
make install-dev
# Install git commit hook for the stylechecker
make install-git-hooks
# Install git commit hook for some extra linting and checking
pre-commit install
# install test dependencies
make install-test
@ -100,9 +100,13 @@ The ``Makefile`` has a lot of options that allow you to control which tests are
run, and which servers are tested. Take a look at its code where they are all
initialized and documented.
For example, to test xandikos, run::
For example, to test xandikos, first run the server itself::
docker-compose build xandikos
docker-compose up -d xandikos
Then run the tests specifying this ``DAV_SERVER``, run::
make DAV_SERVER=xandikos install-test
make DAV_SERVER=xandikos test
If you have any questions, feel free to open issues about it.