Участие в проекте

Если вы хотите принять участие в проекте и сделать его лучше, ваша помощь будет очень ценна. Внесение вклада — это отличный способ узнать больше о социальном программировании на GitHub, новых технологиях и их экосистемах, а также о том, как писать конструктивные, полезные отчеты о багах, запросы на новые возможности и самый благородный вид вклада: чистый и аккуратный pull request.

Как создать чистый pull request

Найдите инструкции по внесению вклада в проект. Если они есть, следуйте им.

• Создайте личную форк проекта на GitHub.
• Клонируйте форк на вашем локальном компьютере. Ваш удаленный репозиторий на GitHub называется origin.
• Добавьте оригинальный репозиторий как удаленный с именем upstream.
• Если вы создали свой форк давно, убедитесь, что вы запустили изменения из upstream в ваш локальный репозиторий.
• Создайте новый ветвь для работы! Бранчейтесь от develop, если таковая существует, иначе от master.
• Реализуйте/почините вашу функцию, прокомментируйте код.
• Следуйте стилю кода проекта, включая отступы.
• Если проект имеет тесты, запустите их!
• Напишите или адаптируйте тесты по мере необходимости.
• Измените документацию по мере необходимости.
• Создайте новую ветвь при необходимости.
• Отправьте свою ветвь на ваш форк на GitHub, удаленный origin.
• Из вашего форка откройте pull request в правильной ветви. Целевой веткой проекта должна быть develop, если она существует, иначе используйте master!
• Подождите одобрения.
• После того, как pull request будет одобрен и объединён, вы можете получить изменения из upstream в ваш локальный репозиторий и удалить ваши дополнительные ветви.

И последнее, но не менее важное: всегда пишите сообщения коммитов в настоящем времени. Сообщение коммита должно описывать то, что делает этот коммит, когда он применяется к коду — а не то, что вы сделали с кодом.