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

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

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

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

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

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

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

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

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

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

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

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