From af3659ac1a573a80a25954177023335cb644825d Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Tue, 9 Jun 2020 10:42:26 +0200 Subject: [PATCH] Update contributing instructions --- docs/contributing.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index deb48f5..449638a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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.