Руководство по внесению вклада

Добро пожаловать! Мы — довольно дружелюбное сообщество, и мы рады, что вы хотите помочь сделать это приложение ещё лучше. Однако мы просим вас следовать некоторым общим рекомендациям, чтобы всё было организовано должным образом.

1. Убедитесь, что создана проблема для ошибки, которую вы собираетесь исправить, или функции, которую вы собираетесь добавить. Сделайте их как можно меньше.

2. Мы используем разветвлённый рабочий процесс на основе функций. Сделайте форк этого репозитория и создайте ветку на основе dev, явно названную в честь функции, над которой вы хотели бы работать. Внесите изменения там. Часто фиксируйте изменения.

3. Перебазируйте коммиты в хорошо отформатированные коммиты. Упомяните проблему, которая решается, в сообщении коммита отдельной строкой, например, Fixes #<bug> (см. Связывание запроса на вытягивание с проблемой для получения дополнительной информации о ключевых словах, которые вы можете использовать).

4. Отправьте запрос на вытягивание, чтобы получить изменения из вашей ветки в dev. Упомяните, какая ошибка решается, в описании.

Перед отправкой запроса на вытягивание для проверки убедитесь, что он правильно отформатирован. Мы используем скрипт format.sh. Вы можете просто запустить его.

Обратите внимание, что это изменяет файлы, но не фиксирует их — вам, вероятно, потребуется запустить git commit --amend -a, чтобы обновить последний коммит со всеми ожидающими изменениями.