Мы очень рады, что вы решили помочь нам в этом проекте! Пожалуйста, следуйте простым правилам, описанным ниже.
-
Сделайте личную копию (fork) этого проекта GitHub'е.
-
Если вы еще не решили, чем вы можете помочь этому проекту, то просмотрите пометки с тегом
@FIXME
в исходном коде. Возможно, что-то из этих пунктов покажется вам интересным. -
Если задуманные изменения велики и вызывают сомнения, инициируйте обсуждение с описанием ваших намерений.
-
Создайте тематическую ветку с говорящим именем:
fb_some_important_fix
. Не стесняйтесь создать несколько веток для связанных по смыслу изменений: принять изменение проще, если оно атомарно, и сложно, если оно велико и противоречиво, когда одна часть приветствуется, а другая не совсем. -
При возникновении сомнений в переводе терминов согласуйте свой перевод с глоссарием.
-
Ссылки на разделы руководства оформляйте на отдельных строках:
<a name="english-comments"></a>
Пишите комментарии по-английски.
<sup>[[ссылка](#english-comments)]</sup>
- Заключайте пояснения в скобки (это не соответствует стилю английского оригинала):
# плохо - пояснение после тире
# хорошо (пояснение в скобках)
-
Проделайте запланированную работу по исправлению ошибок или переводу в созданной тематической ветке. Прокомментируйте вашу работу при добавлении.
-
Пересмотрите содержательность каждого из добавлений (commit), по возможности слейте все в один логически атомарное добавление (commit), используйте для этого
git rebase -i ...
. -
Загрузите вашу ветку на GitHub.
-
Отправье нам запрос на слияние, добавьте комментарий к нему.