From 8ec93c89b73e738a6fc42d42adfa3fe824f6fe68 Mon Sep 17 00:00:00 2001 From: Maxim Slipenko Date: Mon, 26 Aug 2024 15:30:10 +0300 Subject: [PATCH 1/3] chore: add conventional-pre-commit --- .pre-commit-config.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 00eddae..7167028 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -71,3 +71,9 @@ repos: - name: Poetry Check (karkas_piccolo) id: poetry-check args: ["-C", "./src/karkas_piccolo"] + - repo: https://github.com/compilerla/conventional-pre-commit + rev: v3.4.0 + hooks: + - id: conventional-pre-commit + stages: [commit-msg] + args: [] From 64a4066825560b1988daf8da1a2aec223198b159 Mon Sep 17 00:00:00 2001 From: Maxim Slipenko Date: Mon, 26 Aug 2024 15:53:19 +0300 Subject: [PATCH 2/3] docs: add steps with pre-commit install --- docs/DEV.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/DEV.md b/docs/DEV.md index 37f92d2..61fa10b 100644 --- a/docs/DEV.md +++ b/docs/DEV.md @@ -18,12 +18,20 @@ git clone https://gitflic.ru/project/alt-gnome/karkas.git 2. Откройте папку `karkas` в VSCode. Среда разработки автоматически предложит открыть проект как Workspace, используя файл `karkas.code-workspace`. Нажмите `Открыть Workspace`, чтобы принять предложение; -3. Установите инструмент Poetry, следуя инструкциям из [официальной документации](https://python-poetry.org/docs/). Для каждого пакета выполните следующую последовательность действий: +3. Установите инструмент Poetry, следуя инструкциям из [официальной документации](https://python-poetry.org/docs/). + +4. Выполните команду `poetry install` в корне проекта. + +5. Выполните команду `soruce ./.venv/bin/activate` в корне проекта. + +4. Выполните команду `pre-commit install -t commit-msg -t pre-commit` в корне проекта. + +5. Для каждого пакета выполните следующую последовательность действий: - Перейдите в папку пакета (например, `src/karkas_core`); - - Выполните команду `poetry install`, чтобы установить зависимости пакета. После этого будет создано виртуальное окружене (`.venv`); + - Выполните команду `poetry install`, чтобы установить зависимости пакета. -4. Выполните команду `poetry shell` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение. +4. Выполните команду `soruce ./.venv/bin/activate` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение. Теперь рабочее окружение настроено! From fab0b84a61002703490d856ef829e563b10df53d Mon Sep 17 00:00:00 2001 From: Maxim Slipenko Date: Mon, 26 Aug 2024 15:57:39 +0300 Subject: [PATCH 3/3] docs: correct step numbering in setup instructions --- docs/DEV.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DEV.md b/docs/DEV.md index 61fa10b..a3a3f43 100644 --- a/docs/DEV.md +++ b/docs/DEV.md @@ -31,7 +31,7 @@ git clone https://gitflic.ru/project/alt-gnome/karkas.git - Перейдите в папку пакета (например, `src/karkas_core`); - Выполните команду `poetry install`, чтобы установить зависимости пакета. -4. Выполните команду `soruce ./.venv/bin/activate` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение. +6. Выполните команду `soruce ./.venv/bin/activate` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение. Теперь рабочее окружение настроено!