Вклад в Sentinel

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

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

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

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

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

У вас должен быть установлен Go 1.12+ в вашей операционной системе.

Вклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Сообщество

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

Gitter

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