CONTRIBUTING.md

Contribute to AutoIntent

Минимальная конфигурация

Мы используем poetry в качесте менеджера зависимостей и упаковщика.

1. Установить poetry. Советуем обратиться к разделу официальной документации Installation with the official installer. Если кратко, то достаточно просто запустить команду:

curl -sSL https://install.python-poetry.org | python3 -

2. Склонировать проект, перейти в корень

3. Установить проект со всеми зависимостями:

make install

Дополнительно

Чтобы удобнее трекать ошибки в кодстайле, советуем установить расширение ruff для IDE. Например, для VSCode

https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff

С этим расширением ошибки в кодстайле будут подчеркиваться прямо в редакторе.

В корень проекта добавлен файл .vscode/settings.json, который указывает расширению путь к конфигу линтера.

Contribute

1. Создать ветку, в которой вы будете работать. Чтобы остальным было проще понимать характер вашего контрибьюта, нужно давать краткие, но понятные названия начинающиеся. Советем начинать названия на feat/ для веток с новыми фичами, fix/ для исправления багов, refactor/ для рефакторинга, test/ для добавления тестов.

2. Коммит, коммит, коммит, коммит

3. Если есть новые фичи, желательно добавить для них тесты в директорию tests.

4. Проверить, что внесенные изменения не ломают имеющиеся фичи

make test

5. Проверить кодстайл

make lint

6. Ура, можно открывать Pull Request!

Устройство проекта

Построение документации

Построить html версию в папке docs/build:

make docs

Построить html версию и захостить локально:

make serve-docs