mziai/pre-commit-config

pre-commit-config

Этот репозиторий включает в себя конфигурационный файл для pre-commit и настройки для различных линтеров и проверок.

Установка

Установить pre-commit можно, следуя официальной инструкции:

pip install pre-commit

Использование в качестве подмодуля

Подключить этот репозиторий в качестве git-подмодуля можно следующим образом:

# Из корня основного проекта
git submodule add -b master https://github.com/mziai/pre-commit-config.git
git submodule init
git submodule update

Затем нужно создать символическую ссылку в корень основного проекта:

ln -s pre-commit-config/.pre-commit-config.yaml .pre-commit-config.yaml
ln -s pre-commit-config/.clang-format .clang-format

Последним шагом нужно установить хуки в репозитории:

pre-commit install

В дальнейшем, при создании коммитов, код будет автоматически отформатирован в соответствии с конфигурационными файлами. В таких случаях потребуется после git commit добавить изменения с помощью git add и повторно их закоммитить.

Участие

Если заметили неточности или есть желание улучшить проект, можно отравить pull request или создать issue.