Вы решили внести свой вклад в общий проект, и это здорово! Я приветствуем это!
Но вы должны понимать всю ответственность, этот проект используется, и если вы что-то меняете, вы должны быть уверены что вы не навредили никому.
Поэтому у меня есть ряд требований и пожеланий, пожалуйста, ознакомьтесь с ними в первую очередь.
- Все разработки сливаем в
mainветку (работаем только с ней). - Когда мы создаем новую функцию, мы называем ветку
feature_* - Когда мы что-то исправляем, мы называем ветку
fix_* - Не забудьте обновить CHANGELOG.md перед открытием MP.
- Если что-то изменилось, проверяем актуальность документации
- В тексте MR мы четко описываем, что изменилось и почему, если есть проблема, тогда мы ссылаемся на нее.
- Если MR открыт, но еще не готов, оставьте его в статусе draft пока не будет готово.
- Коммиты именуем согласно conventional commits (можно добавить смайлы, но не рекомендуется)
Убедитесь, что ваш запрос на слияние соответствует следующим правилам:
- Поищите предыдущие предложения, прежде чем делать новые, так как у вас может быть дубликат.
- Перед отправкой убедитесь, что ваш вклад полезен.
- Создайте запрос на слияние для каждого предложения.
- Заголовки должны быть написаны с заглавной буквы.
- Приветствуются новые категории или улучшения существующей категоризации.
- Проверьте орфографию и грамматику.
- Убедитесь, что ваш текстовый редактор настроен на удаление конечных пробелов.
- Запрос на слияние и текст коммита должны иметь полезный заголовок.
Спасибо вам за ваш вклад!