Вклад в Sentinel

Добро пожаловать в Sentinel! Этот документ представляет собой руководство о том, как внести вклад в Sentinel. Если вы обнаружите что-то неправильное или отсутствующее, пожалуйста, оставьте комментарии / предложения.

Прежде чем начать

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

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

Настройка среды разработки

У вас должен быть установлен JDK 1.8 или более поздней версии в вашей системе.

Вклад

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

Мы высоко ценим документацию и интеграцию с другими проектами. Мы очень рады принять улучшения по этим аспектам.

Рабочий процесс GitHub

Мы используем ветку master в качестве ветки разработки, что указывает на то, что это нестабильная ветка.

Вот рабочий процесс для участников:

1. Форк на свой собственный
2. Клонируйте форк в локальный репозиторий
3. Создайте новую ветку и работайте над ней
4. Поддерживайте свою ветку в актуальном состоянии
5. Зафиксируйте свои изменения (убедитесь, что ваше сообщение о фиксации краткое)
6. Отправьте свои коммиты в свой разветвлённый репозиторий
7. Создайте пул реквест

Пожалуйста, следуйте шаблону пул реквеста. Убедитесь, что у PR есть соответствующая проблема.

После создания PR одному или нескольким рецензентам будет назначен пул реквест. Рецензенты рассмотрят код.

Перед объединением PR объедините любые отзывы об исправлении ошибок, опечатки, объединённые и перебазированные типы коммитов. Окончательное сообщение коммита должно быть ясным и кратким.

Откройте вопрос / PR

Мы используем Проблемы GitHub и Пул реквесты для отслеживания.

Если вы найдёте опечатку в документе, обнаружите ошибку в коде, захотите новые функции или захотите дать предложения, вы можете открыть вопрос на GitHub, чтобы сообщить об этом. Следуйте указаниям в шаблоне проблемы.

Если вы хотите внести свой вклад, пожалуйста, следуйте рабочему процессу вклада и создайте новый пул реквест. Если ваш PR содержит большие изменения, например, рефакторинг компонента или новые компоненты, пожалуйста, напишите подробные документы о его дизайне и использовании.

Обратите внимание, что один PR не должен быть слишком большим. Если требуются серьёзные изменения, лучше разделить изменения на несколько отдельных PR.

Проверка кода

Весь код должен быть тщательно проверен одним или несколькими коммиттерами. Некоторые принципы:

• Читаемость: Важный код должен быть хорошо документирован. Соблюдайте наш стиль кода.
• Элегантность: Новые функции, классы или компоненты должны быть хорошо спроектированы.
• Тестируемость: Важный код должен иметь хорошее тестирование (высокое покрытие модульными тестами).

Сообщество

Свяжитесь с нами

Список рассылки

Если у вас есть какие-либо вопросы или советы, пожалуйста, свяжитесь с sentinel@linux.alibaba.com.

Gitter

Наша комната Gitter: https://gitter.im/alibaba/Sentinel.