Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 2.87 KB

Добро пожаловать

Радостно видеть, что вам интересны наши проекты. Прежде всего стоит отметить, что общение между участниками мы производим на форуме Mirea.Ninja в разделе OpenSource Space. Будьте вежливы, не переходите на личности. Помните, Issues страница - не место для общения не по теме.

Ваше участие

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

Есть несколько принципов, которых нужно придерживаться:

  1. Уважайте чужой труд. Если вы что-то откуда-то заимствуете, то обязательно указывайте источники.
  2. Тщательно документируйте свой код.
  3. Придерживайтесь стандартов оформления кода.

Соглашение о префиксах коммитов

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

  • FIX: исправление ошибок
  • FEATURE: добавление новых функциональных возможностей (фич)
  • DOCS: изменения только в документации
  • TEST: добавление отсутствующих тестов или исправление существующих тестов
  • PERF: повышение производительности приложения
  • UX: изменения пользовательского интерфейса или способов взаимодействия с ним
  • SECURITY: изменение, устраняющее проблему безопасности
  • REFACTOR: изменение кода, которое не исправляет ошибку и не добавляет функцию

REFACTOR-only коммиты не приветствуются. Коммиты, которые добавляют только тесты или документацию - приветствуются.


Вся разработка ведётся в ветке dev. Имейте это в виду, прежде чем создавать pull request.