1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/kubewharf-kubezoo

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 9.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 26.11.2024 00:13 a6f5fd5

Вклад в KubeZoo

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

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

Темы

Сообщение о проблемах безопасности

Мы серьёзно относимся к проблемам безопасности и не рекомендуем никому распространять информацию о них. Если вы обнаружите проблему безопасности в KubeZoo, пожалуйста, не обсуждайте её публично и даже не открывайте публичный вопрос. Вместо этого мы рекомендуем вам отправить нам личное электронное письмо по адресу {TODO: адрес команды}, чтобы сообщить о проблеме безопасности.

Сообщение об общих проблемах

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

Поскольку разработка KubeZoo будет осуществляться распределённым образом, мы ценим ХОРОШО НАПИСАННЫЕ, ПОДРОБНЫЕ и ЯСНЫЕ отчёты о проблемах. Чтобы сделать общение более эффективным, мы предлагаем всем искать, не является ли ваша проблема уже существующей, прежде чем создавать новую. Если вы считаете, что она существует, добавьте свои детали в комментарии к вопросу.

Существует множество случаев, когда вы можете открыть вопрос:

  • Отчёт об ошибке
  • Запрос на функцию
  • Проблемы с производительностью
  • Предложение функции
  • Дизайн функции
  • Требуется помощь
  • Неполная документация
  • Улучшение теста
  • Любые вопросы о проекте и так далее

Напоминаем, что при создании нового вопроса удалите конфиденциальные данные из своего сообщения. Конфиденциальными данными могут быть пароль, секретный ключ, сетевые местоположения, личные бизнес-данные и так далее.

Вклад кода и документации

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

  • Если вы найдёте опечатку, попробуйте исправить её!
  • Если вы обнаружите ошибку, попробуйте исправить её!
  • Если вы увидите избыточный код, попробуйте удалить его!
  • Если вы заметите отсутствие тестовых примеров, попробуйте добавить их!
  • Если вы сможете улучшить функцию, пожалуйста, НЕ СТЕСНЯЙТЕСЬ!
  • Если код кажется вам неявным, попробуйте добавить комментарии, чтобы сделать его понятным!
  • Если вы видите технические долги, попробуйте реорганизовать их!
  • Если документ кажется вам неправильным, исправьте это!

Невозможно перечислить их полностью, мы с нетерпением ждём ваших запросов на включение. Прежде чем отправлять PR, предлагаем вам ознакомиться с правилами PR здесь.

  • Подготовка рабочего пространства
  • Определение ветки
  • Правила фиксации
  • Описание PR

Подготовка рабочего пространства

Предполагается, что у вас уже есть учётная запись GitHub, тогда вы можете завершить подготовку следующими шагами:

  1. ФОРК KubeZoo в свой репозиторий. Чтобы это сработало, вам просто нужно нажать кнопку «Форк» в правом верхнем углу главной страницы kubezoo. Затем у вас появится ваш репозиторий по адресу https://github.com//kubezoo, где username — это ваш идентификатор GitHub.
  2. КЛОНИРУЙТЕ свой собственный репозиторий для локальной разработки. Используйте git clone https://github.com/<имя пользователя>/kubezoo.git, чтобы клонировать репозиторий на свой локальный компьютер. Затем вы можете создать новые ветки, чтобы завершить изменение, которое вы хотите внести.
  3. Установите удалённый апстрим на kubezoo с помощью следующих двух команд:
git remote add upstream https://github.com/kubezooio/kubezoo.git
git remote set-url --push upstream no-pushing

С этой настройкой удалённого доступа вы можете проверить конфигурацию git удалённо следующим образом:

$ git remote -v
origin     https://github.com/<имя пользователя>/kubezoo.git (fetch)
origin     https://github.com/<имя пользователя>/kubezoo.git (push)
upstream   https://github.com/kubezooio/kubezoo.git (fetch)
upstream   no-pushing (push)

Благодаря этому мы можем легко синхронизировать локальные ветки с ветками upstream.

Определение ветки

Сейчас мы предполагаем, что каждый вклад через запрос на включение предназначен для ветки master в KubeZoo. Существует несколько других веток, таких как ветки rc, ветки выпуска и ветки backport. Перед официальным выпуском версии мы можем оформить ветку rc (кандидата на выпуск) для дополнительных тестов. Когда официально выпускается версия, перед созданием тега может существовать ветка релиза, которая будет удалена после создания тега.

При переносе некоторых исправлений в существующую выпущенную версию мы будем проверять ветки обратного портирования.

Правила фиксации изменений

В KubeZoo мы серьёзно относимся к двум правилам для представленных PR:

Сообщение о фиксации

TODO

Содержание фиксации

TODO.

Описание PR

PR — это единственный способ внести изменения в проект KubeZoo. Чтобы помочь рецензентам, мы фактически призываем участников делать описание PR как можно более подробным.

Примите участие, чтобы помочь

GitHub — это основное место для совместной работы участников KubeZoo. Хотя внесение вклада через PR является явным способом помочь, мы всё ещё призываем к любой другой помощи.

  • Отвечайте на вопросы других пользователей, если можете;
  • Помогайте решать проблемы других пользователей;
  • Помогите с дизайном PR других пользователей;
  • Просмотрите код в PR других пользователей;
  • Обсудите KubeZoo, чтобы сделать вещи понятнее;
  • Продвигайте технологию KubeZoo за пределами GitHub;
  • Пишите блоги о KubeZoo и так далее.

Одним словом, ЛЮБАЯ ПОМОЩЬ МОЖЕТ БЫТЬ ВКЛАДОМ.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/kubewharf-kubezoo.git
git@api.gitlife.ru:oschina-mirror/kubewharf-kubezoo.git
oschina-mirror
kubewharf-kubezoo
kubewharf-kubezoo
main