Вклад в проект Lookout

Lookout выпущен под лицензией Apache 2.0 и следует стандартному процессу разработки на Github, используя Github tracker для отслеживания проблем и объединения запросов на вытягивание в мастер. Если вы хотите внести свой вклад или просто хотите поработать над кодом, этот документ поможет вам начать работу.

Подпишите Лицензионное соглашение участника

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

Соглашения о коде

Ни одно из них не является обязательным для запроса на вытягивание, но все они помогут.

1. Мы предоставили файл форматирования кода (Formatter.xml), он автоматически отформатирует ваш проект во время процесса сборки.
2. Убедитесь, что все новые файлы .java имеют простой комментарий класса Javadoc как минимум с тегом @author, идентифицирующим вас, и предпочтительно хотя бы абзацем о том, для чего предназначен класс.
3. Добавьте комментарий заголовка лицензии ASF ко всем новым файлам .java (скопируйте из существующих файлов в проекте).
4. Добавьте себя в качестве автора в файлы .java, которые вы существенно изменяете (более чем косметические изменения).
5. Добавьте некоторые Javadocs.
6. Также очень помогли бы несколько модульных тестов — кто-то должен их сделать.
7. При написании сообщения о фиксации, пожалуйста, следуйте этим соглашениям. Если вы исправляете существующую проблему, добавьте в конце сообщения о фиксации «Fixes gh-XXXX» (где XXXX — номер проблемы).