Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.9 KB

CONTRIBUTION.md

File metadata and controls

42 lines (29 loc) · 1.9 KB

Правила для контрибуторов

Установка EnjAlice

Устанавливается фреймворк с помощью pip, фреймворк требует версии Python 3.9+.

pip install enjalice

Наименование веток

Ветки именовать следует в виде <author>_<branch-type>_<branch-name>. Тип ветки может быть WIP (work in progress), Bug, Feature, Junk (ветка для экспериментов).

Внутри ветки коммиты стоит делать на английском языке, в коммите должно описываться изменение, которое было совершено.

Тестирование

Тесты пишутся в папке /tests - для каждой функциональности свой файл теста.

Пишутся тесты с использованием pytest.

Для тестирования изменений на собственном боте необходимо его создать. Для этого в Консоли в Яндекс.Диалогах необходимо создать новый диалог. Для шеринга бота с локальной сети в глобальную можно использовать ngrok. Заполнив все поля (для тестирования бота следует оставить Тип доступа: Приватный), нажать Опубликовать, и, немного переждав, зайти во вкладку Тестирование.

Pull requests (PR)

После всех изменений и тестов необходимо сделать Pull Request, в названии которого будет краткое описание измненения.

Спасибо за контрибьютинг!