Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.92 KB

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

Нам очень поможет, если при создании Pull Request вы будете придерживаться следующих рекомендаций:

Предложения по улучшению проекта

Проект открыт к идеям и новым воплощениям. Чтобы ваша идея была оценена и воплощена, обратите внимание на следующие рекомендации:

  1. Используйте поиск задач на GitHub — проверьте, была ли идея уже обсуждаема ранее.

  2. Сообщите об идее через создание нового Issue в проекте. Пожалуйста, постарайтесь быть как можно более подробным в своем отчете.

  3. Если вашу идею поддержали, то предложите пул-реквест с реализацией.

Отчеты об ошибках

Ошибка — это демонстрируемая проблема, вызванная кодом в репозитории. Хорошие отчеты об ошибках чрезвычайно полезны - спасибо!

Рекомендации по сообщениям об ошибках:

  1. Используйте поиск задач на GitHub — проверьте, была ли проблема уже сообщена ранее.

  2. Проверьте, устранена ли проблема — попробуйте воспроизвести с помощью последней main веткой или веткой разработки в репозитории.

  3. Изолируйте проблему — в идеале создать сокращенный тест кейс и живой пример.

  4. Сообщите о проблеме через создание нового Issue в проекте. Пожалуйста, постарайтесь быть как можно более подробным в своем отчете. Включите конкретные шаги, необходимые для воспроизведения проблемы.

  5. Предложите пул-реквест с реализацией.

Пул-реквесты

Хорошие пулл-реквесты — возможность начинающим разработчикам поучаствовать в OpenSource разработке, получить обратную связь профессиональных разработчиков, составить своё портфолио открытых работ. Они должны оставаться сфокусированными по объему на одной проблеме и избегать несвязанных изменений.

  1. Сделайте коммит с вашими изменениями, используя в названии коммита ссылку на решаемую проблему по шаблону:

    [issues-1] Реализовал такую-то возможность

  2. Запуште свои изменения в свою ветку вашего форка.

  3. Откройте пул-реквест с четким названием и описанием ваших изменений.

Контакты

По возникшим вопросом смело обращайтесь к команде проекта по контактам команды отсюда.

Благодарности

Каждый участник сделавший свой вклад будет отмечен в нашем списке благодарности вот тут.