Как стать участником проекта#

Для того, чтобы принять участие в развитии проекта bosk, можно сделать несколько вещей:

  • Написать код для введения новой функциональности в фреймворк или описания существующей в примере.

  • Предложить исправление бага или ошибки.

  • Предложить улучшение документации проекта.

  • Рассмотреть и дать оценку открытым pull request’ам в GitHub.

Репозиторий bosk располагается в GitHub, и наша команда использует систему контроля версий Git. Предпочитаемый способ внесения изменений в bosk - это сделать fork основного репозитория (ветки main), провести необходимые работы в своей копии репозитория и предложить рассмотреть внесенные изменения с помощью выполнения pull request.

Установка окружения для разработки#

Мы рекомендуем Вам создать отдельное Python окружение с помощью venv или conda, после чего обратиться к нашему руководству по установке и установить пакет bosk в режиме разработчика.

Внесение изменений в код#

Для того, чтобы Ваш pull request одобрили, ваш код должен удовлетворять следующим требованиям:

  1. Все изменения, относящиеся к одной функциональной единице, должны принадлежать

одной ветке. Каждая ветка должна быть самодостаточной с единственной новой введенной в фремворк функцией или исправлением единственной ошибки. Вы можете создать новую ветку, выполнив:

git checkout -b new-feature-name

  1. Весь код должен соответствовать стандартным требованиям к стилю кодирования на языке Python

PEP8. Дополнительно наша команда старается, чтобы код соответствовал стилю кодирования google. Чтобы проверять код на соответствие описанному стилю, мы используем pylint.

  1. Каждая функция, класс, метод и их атрибуты должны быть задокументированы

с помощью инструмента «doc strings» языка Python. Мы использвуем стандарт написания google.

  1. Предлагаемый код всегда должен сопровождаться юнит-тестами.

Мы используем pytest для тестирования bosk. Все тесты должны находиться в директории tests. Вы можете выполнить все юнит-тесты для bosk, выполнив:

pytest

  1. Помните о том, что мы используем лицензию MIT для проекта bosk, и предлагаемый Вами код должен ей соответствовать.

Добавление Pull Request#

Сделайте один или несколько коммитов в вашу ветку. Каждый коммит должен отвечать конкретным внесенным изменениям. Сообщения коммитов далжны быть короткими и информативными. Когда Вы закончите работу с кодом, создайте pull request.

Сборка документации#

Документация проекта находится в папке docs, и написана в формате reStructuredText. HTML-файлы документации могут быть сгенерированы с помощью Sphinx. Перед сборкой документации убедитесь, что у вас установлены пакеты, перечисленные в docs/requirements.txt.

Note

Мы используем Jupyter блокноты для иллюстрации примеров. Для их правильного рендеринга необходимо вручную установить утилиту Pandoc.

Самый простой способ собрать документацию - это выполнить:

cd docs
make html

Сгенерированные файлы будут находиться в docs/_build/html.