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

SOFATracer распространяется под лицензией 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 — номер проблемы).