Внесение вклада в Dockin-CNI

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

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

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

В вашей операционной системе должен быть установлен Golang.

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

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

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

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

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

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

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

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

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

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

Откройте проблему / PR

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

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

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

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

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

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

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

Сообщество

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