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

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

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

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

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

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

1. Мы предоставили файл конфигурации форматера кода, который автоматически будет форматировать ваш проект во время сборки.

2. Убедитесь, что все новые файлы .java имеют простое описание класса Javadoc с хотя бы одним тегом @author, указывающим на вас, а также желательно наличие хотя бы одного абзаца, описывающего назначение класса.3. Добавьте заголовок лицензии ASF ко всем новым файлам .java (скопируйте его из существующих файлов проекта).

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

4. Добавьте некоторые Javadoc'ы.

5. Несколько unit-тестов тоже очень помогли бы — кто-то должен этим заняться.

6. При написании сообщения о коммите следуйте этим конвенциям, если вы исправляете существующую проблему, добавьте Fixes gh-XXXX в конце сообщения о коммите (где XXXX — номер проблемы).