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

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

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

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

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

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

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

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

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

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

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

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