feat: add pre-commit hooks

Add pre-commit hooks for running pylint and gitlint.

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/PyCQA/pylint
+    rev: pylint-2.5.0
+    hooks:
+    -   id: pylint
+-   repo: https://github.com/jorisroovers/gitlint
+    rev: v0.13.1
+    hooks:
+    -   id: gitlint

Pipfile

@@ -12,6 +12,7 @@ fire = "*"
 configparser = "*"
 gitlint = "*"
 pylint = "*"
+pre-commit = "*"
 
 [requires]
 python_version = "3.7"

README.md

@@ -67,10 +67,16 @@ The following instructions help you for developing.
 * Clone this git repo
 * Install pipenv: `pip install pipenv`
 * Install all dependencies: `pipenv install`
+* Install git pre-commit hooks (for pylint and gitlint) with `pre-commit install`
 * You can run the tests with `python -m unittest`
+* After pushing, you should check the build status which currently checks the tests, pylint and the commit message format.
+
+### Notes
+
+The following steps are automatically executed via pre-commit hooks.
+
 * You can run pylint with `pylint gitea_auto_update`
 * 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, pylint and the commit message format.
 
 ## Contributors