diff --git a/.gitlint b/.gitlint new file mode 100644 index 0000000..2da2887 --- /dev/null +++ b/.gitlint @@ -0,0 +1,5 @@ +[general] +contrib=contrib-title-conventional-commits + +[contrib-title-conventional-commits] +types = build,ci,docs,feat,fix,perf,refactor,style,test \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index a979c14..6fc5e50 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,4 +7,5 @@ install: - pip install pipenv - pipenv install script: + - gitlint - python tests.py diff --git a/Pipfile b/Pipfile index b2f3bc0..4f197c4 100644 --- a/Pipfile +++ b/Pipfile @@ -10,6 +10,7 @@ requests = "*" packaging = "*" fire = "*" configparser = "*" +gitlint = "*" [requires] python_version = "3.7" 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