From cf53f7b9dce837fbfbdbfcc569ba92922dc64432 Mon Sep 17 00:00:00 2001 From: Christoph Miksche Date: Wed, 11 Sep 2019 13:48:50 +0200 Subject: [PATCH] docs: update development instructions Add more instructions for development to the README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c45de94..e2a6da0 100644 --- a/README.md +++ b/README.md @@ -62,9 +62,13 @@ If you want to schedule your updates, edit your /etc/crontab file. The following instructions help you for developing. +* Check out the [Contribution Guidelines](CONTRIBUTING.md). * Clone this git repo * Install pipenv: `pip install pipenv` * Install all dependencies: `pipenv install` +* You can run the tests with `python tests.py` +* After changes and commit, you can check if your commit message follows the contribution guidelines with `gitlint`. If there is a problem, gitlint will show you a error message. +* After pushing, you should check the build status which currently checks the tests and the commit message format. ## Contributors