Внесение вклада в Apollo

Apollo распространяется под лицензией Apache 2.0 с открытым исходным кодом, которая не накладывает ограничений, и использует стандартный процесс развития через GitHub, где используются трекеры GitHub для отслеживания задач и слияния пулл-запросов в основной ветке. Если вы хотите внести даже небольшой вклад, не стесняйтесь делать это, следуя нижеописанным руководствам.

Подпишите соглашение о правах авторства

Перед тем как мы примем значительный патч или пулл-запрос, нам потребуется ваше подписание соглашения о правах авторства. Подписание этого соглашения не предоставляет вам права на прямое изменение основной ветки репозитория, но позволяет нам принять ваши вклады, а также обеспечивает вам авторское право при этом. Активные участники могут быть приглашены в команду разработчиков, что позволит им иметь возможность мерджить пулл-запросы.

Конвенции кодирования

Наши конвенции кодирования совпадают с Google Java Style Guide.

Мы предлагаем шаблонные файлы intellij-java-google-style.xml для IntelliJ IDEA и eclipse-java-google-style.xml для Eclipse. Если вы используете другую среду разработки, то можете настроить её вручную, ориентируясь на эти шаблоны.* При создании сообщения о коммите, пожалуйста, следуйте этим соглашениям: если вы исправляете существующую проблему, добавьте Fixes #XXX в конце сообщения о коммите (где XXX — это номер проблемы).

• Убедитесь, что все новые файлы .java содержат простое комментарий Javadoc класса с хотя бы одним тегом @author, который указывает на вас, и желательно хотя бы один абзац о том, для чего предназначен этот класс.

• Добавьте себя как автора (@author) в .java файлах, которые вы значительно модифицировали (более чем косметические изменения).

• Добавьте некоторые Javadocs и, если вы меняете пространство имен, некоторые элементы документирования XSD.

• Для новой функции или важного исправления ошибки следует добавить несколько тестов.

• Если никто другой не использует вашу ветку, пожалуйста, сделайте ребейз относительно текущей основной ветки (или другой целевой ветки в основном проекте).

• Обычно, мы объединяем коммиты для одной функции в один коммит. Есть два способа сделать это:

  1. Чтобы сделать ребейз и объединить коммиты на основе удалённой ветки

     • git rebase -i <remote>/master
     • объедините коммиты через fixup, и т.д.

  2. Создайте новую ветку и объедините эти коммиты в один

     • git checkout -b <название_ветки> <remote>/master
     • git merge --squash <текущая_ветка_функции>