Вклад в Brooklin

Прежде всего, благодарим вас за то, что вы нашли время внести свой вклад в проект Brooklin.

Внести свой вклад можно путём создания форка репозитория и отправки пул-реквеста в основную ветку этого репозитория.

Пожалуйста, уделите время изучению наших Рекомендаций по внесению вклада перед созданием новой задачи или отправкой PR.

Соглашение о внесении вклада

Как участник, вы заявляете, что код, который вы предоставляете, является вашей оригинальной работой или работой вашего работодателя (в этом случае вы заявляете, что имеете право связывать своего работодателя обязательствами). Предоставляя код, вы (и, если применимо, ваш работодатель) передаёте его в пользование LinkedIn и сообществу открытого исходного кода на условиях лицензии BSD 2-Clause.

Ответственное раскрытие уязвимостей безопасности

Пожалуйста, не сообщайте об уязвимостях безопасности через Github. Ознакомьтесь с рекомендациями по адресу https://www.linkedin.com/help/linkedin/answer/62924. Отчёты должны быть зашифрованы с использованием открытого PGP-ключа LinkedIn и отправлены на адрес security@linkedin.com, предпочтительно с заголовком «GitHub linkedin/Brooklin — < краткое описание >».

Рекомендации по внесению вклада

Кодекс поведения

Пожалуйста, ознакомьтесь с нашим Кодексом поведения.

Руководство по стилю кодирования Java

Наши рекомендации по стилю кодирования на Java записаны в файле конфигурации Checkstyle, который находится в этом репозитории.

Стиль сообщений Git Commit

1. Разделяйте тему и тело сообщения пустой строкой.
2. Ограничьте длину строки темы до 120 символов.
3. Обрывайте тело сообщения на 100 символах.
4. Начинайте строку темы с заглавной буквы.
5. Не заканчивайте строку темы точкой.
6. Не делайте ссылок на внутренние тикеты Jira.

Вот пример хорошего сообщения Git commit:

Кратко опишите изменения, используя не более 120 символов

При необходимости добавьте более подробное объяснение. Ограничьтесь примерно 100 символами или около того. Пустая строка, разделяющая резюме и тело, имеет решающее значение (если только вы не опускаете тело полностью); инструменты вроде rebase могут запутаться, если вы объедините их вместе. Дополнительные абзацы идут после пустых строк.

 - Точки также можно использовать для обозначения пунктов списка, но здесь конвенции различаются