For developersΒΆ

  1. Fetch code source

git clone https://github.com/a-da/custolint.git
  1. Install dev version from CLI

# activate your venv
# source /path/to/venv/bin/activate

$ make update_pip_and_wheel install_dev
pip install -e .[dev]
Obtaining file:///Users/.../github.com/custolint
Installing build dependencies ... done
...
Successfully installed custolint-....

Add newly setup venv to your IDE.

  1. Validate your changes

$ make validate
coverage run --branch -m pytest
...
tests/test_custolint.py .... [100%]

MAIN_BRANCH='master' custolint coverage .coverage
...
MAIN_BRANCH='master' custolint pylint
...
MAIN_BRANCH='master' custolint flake8
...
MAIN_BRANCH='master' custolint mypy
  1. Increase version (manually) of the package to be release setup.cfg:version

  1. Open Pull Request

git commit ...
git push ...
  1. Github Action will be triggered see https://github.com/a-da/custolint/actions