Вклад в Nacos

Добро пожаловать в Nacos! Этот документ представляет собой руководство о том, как внести свой вклад в Nacos.

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

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

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

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

Вклад

Nacos приветствует новых участников любой роли, включая пользователя, участника, коммиттера и PMC.

Мы поощряем новичков активно присоединяться к проектам Nacos и участвовать от ролей пользователей до ролей коммиттеров и даже ролей PMC. Чтобы достичь этого, новичкам необходимо активно вносить свой вклад в проект Nacos. В следующем абзаце рассказывается, как вносить вклад в Nacos.

Откройте / возьмите на себя задачу для подготовки

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

Если вы просто хотите внести непосредственный вклад, вы можете выбрать одну из следующих задач:

• Contribution Welcome: Сильно необходимая задача, но в настоящее время не хватает рук.

• good first issue: Подходит для новичков, новички могут выбрать одну для разминки.

Мы придаём большое значение документации и интеграции с другими проектами, такими как Spring Cloud, Kubernetes, Dubbo и т. д. Мы очень рады работать над любыми вопросами, связанными с этими аспектами.

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

Начните свой вклад

Теперь, если вы хотите внести свой вклад, создайте новый запрос на вытягивание.

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

Кроме того, наша модель ветвления соответствует https://nvie.com/posts/a-successful-git-branching-model/. Мы настоятельно рекомендуем новым участникам ознакомиться с вышеуказанной статьёй перед созданием PR.

Теперь, когда вы готовы создать PR, вот рабочий процесс для участников:

1. Форкните себе.

2. Клонируйте форк в локальный репозиторий.

3. Создайте новую ветку и работайте над ней.

4. Поддерживайте свою ветку в актуальном состоянии.

5. Зафиксируйте свои изменения (убедитесь, что ваше сообщение о фиксации краткое).

6. Отправьте свои коммиты в свой разветвлённый репозиторий.

7. Создайте запрос на вытягивание в ветку develop.

При создании запроса на вытягивание:

1. Пожалуйста, следуйте шаблону запроса на вытягивание.

2. Пожалуйста, создайте запрос в ветке develop.

3. Убедитесь, что PR имеет соответствующий вопрос.

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

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

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

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

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

Руководство по проверке кода

Коммиттеры будут по очереди проверять код, чтобы убедиться, что все PR будут проверены своевременно и хотя бы одним коммиттером перед слиянием. Если мы не выполняем свою работу (иногда мы что-то упускаем). И, как всегда, мы приветствуем добровольцев для проверки кода.

Некоторые принципы:

• Читаемость — важный код должен быть хорошо документирован. API должен иметь Javadoc. Стиль кода должен соответствовать существующему.

• Элегантность: Новые функции, классы или компоненты должны быть хорошо спроектированы.

• Тестируемость — 80 % нового кода должно быть покрыто модульными тестовыми примерами.

• Сопровождаемость — соответствует нашему PMD.