Как внести свой вклад¶

Быстрый чек-лист¶

Руководство по участию¶

Мы приветствуем вклад в проект. Чтобы внести свой вклад, пожалуйста, следуйте этим шагам:

Клонирование репозитория
- Сделайте форк репозитория в свой аккаунт на GitHub.
- Клонируйте свой форкнутый репозиторий на локальную машину с помощью следующей команды:
```
git clone https://github.com/Anaxagor/applyBN.git
```
- Перейдите в директорию проекта:
```
cd applyBN
```
Создание ветки
- Создайте новую ветку для вашей фичи или исправления бага:
```
git checkout -b ваше-имя-ветки
```
Поддержание совместимости со sklearn
- Убедитесь, что ваши изменения совместимы с scikit-learn, где это применимо. Это включает в себя соблюдение их конвенций, наследование их классов и обеспечение совместимости.
Написание документации с примером использования
- Мы используем mkdocs для документации. Добавьте или обновите документацию в директории docs.
- Включите примеры использования, чтобы продемонстрировать, как использовать вашу фичу или изменения.
- Для предварительного просмотра документации локально выполните:
```
mkdocs serve
```
Написание юнит-тестов
- Напишите юнит-тесты для вашего кода, чтобы обеспечить его корректность.
- Разместите ваши тесты в директории tests.
- Запустите тесты, чтобы убедиться, что все работает:
```
pytest -s tests
```
Отправка ваших изменений
- Закоммитьте свои изменения с описательным сообщением коммита:
```
git commit -m "Описание ваших изменений"
```
- Отправьте свою ветку в ваш форкнутый репозиторий:
```
git push origin ваше-имя-ветки
```
- Откройте pull request в оригинальном репозитории и предоставьте подробное описание ваших изменений.

Спасибо за ваш вклад!