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

OSCHINA-MIRROR/mirrors-topology

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

Вклад в топологию

Мы будем рады, если вы внесёте свой вклад в развитие топологии и поможете сделать её ещё лучше! Вот наши рекомендации для участников:

Нашли ошибку?

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

Не хватает функции?

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

  • Для основной функции сначала откройте проблему и опишите своё предложение, чтобы его можно было обсудить. Это также позволит нам лучше координировать свои усилия, предотвращать дублирование работы и помогать вам вносить изменения, которые будут успешно приняты в проект.
  • Небольшие функции можно разработать и сразу отправить как запрос на изменение.

Рекомендации по отправке

Отправка сообщения о проблеме

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

Мы хотим исправить все проблемы как можно скорее, но перед исправлением ошибки нам нужно воспроизвести и подтвердить её. Чтобы воспроизвести ошибки, мы будем систематически просить вас предоставить минимальный сценарий воспроизведения с помощью http://plnkr.co. Наличие живого воспроизводимого сценария даёт нам массу важной информации без необходимости задавать дополнительные вопросы, такие как:

  • версия топологии, которую вы используете;
  • сторонние библиотеки и их версии;
  • и самое главное — вариант использования, который не работает.

Минимальный сценарий воспроизведения с использованием http://plnkr.co/ позволяет нам быстро подтвердить наличие ошибки (или указать на проблему в коде), а также убедиться, что мы исправляем правильную проблему. Если plunker не подходит для демонстрации проблемы (например, для проблем, связанных с нашей упаковкой npm), создайте отдельный репозиторий git, демонстрирующий проблему.

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

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

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

Отправка запроса на изменение (PR)

Перед отправкой запроса на изменение рассмотрите следующие рекомендации:

  • Поищите на GitHub открытые или закрытые PR, связанные с вашей отправкой. Вы не хотите дублировать усилия.

  • Внесите изменения в новую ветку git:

    git checkout -b my-fix-branch master
  • Создайте патч, включая соответствующие тестовые случаи.

  • Следуйте нашим правилам кодирования.

  • Запустите полный набор тестов топологии , и убедитесь, что все тесты пройдены.

  • Фиксация изменений с использованием описательного сообщения о фиксации, которое соответствует нашим соглашениям о сообщениях о фиксации. Соблюдение этих соглашений необходимо, поскольку примечания к выпуску автоматически генерируются на основе этих сообщений.

    git commit -a
    ``` **Опция будет автоматически добавлять и удалять отредактированные файлы.**
    
  • Отправьте изменения в ветку на GitHub:

    git push origin my-fix-branch
  • На GitHub отправьте pull request в topology:master.

  • Если мы предложим внести изменения, то:

    • Внесите необходимые обновления.

    • Заново запустите тестовые наборы топологии, чтобы убедиться, что тесты всё ещё проходят.

    • Перебазируйте вашу ветку и принудительно отправьте изменения в ваш репозиторий на GitHub (это обновит ваш запрос на pull):

      git rebase master -i
      git push -f

Это всё! Спасибо за ваш вклад!

После того как ваш pull request будет объединён

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

  • Удалите удалённую ветку на GitHub через веб-интерфейс GitHub или локальную командную оболочку следующим образом:

    git push origin --delete my-fix-branch
  • Проверьте основную ветку:

    git checkout master -f
  • Удалите локальную ветку:

    git branch -D my-fix-branch
  • Обновите основную ветку последней версией из восходящего потока:

    git pull --ff upstream master

Правила кодирования

Чтобы обеспечить согласованность исходного кода, помните об этих правилах при работе:

  • Все функции или исправления ошибок должны быть протестированы одним или несколькими тестами (юнит-тесты).
  • Все публичные методы API должны быть документированы.

Рекомендации по оформлению сообщений о фиксации

У нас есть очень точные правила относительно того, как могут быть отформатированы наши сообщения о фиксации git. Это приводит к более читаемым сообщениям, которые легко отслеживать при просмотре истории проекта. Кроме того, мы используем сообщения git commit для создания журнала изменений топологии.

Формат сообщения о фиксации

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

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Заголовок является обязательным, а область действия заголовка — необязательной.

Любая строка сообщения о фиксации не должна превышать 100 символов! Это позволяет сообщению легче читаться на GitHub, а также в различных инструментах git.

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

Примеры: (ещё больше примеров)

docs(changelog): обновить журнал изменений до beta.5
fix(release): необходимо зависеть от последних rxjs и zone.js

Версия в нашем package.json копируется в ту, которую мы публикуем, и пользователям нужна последняя из них.

Возврат

Если фиксация отменяет предыдущую фиксацию, она должна начинаться с revert: , за которым следует заголовок отменённой фиксации. В теле должно быть написано: «Это отменяет фиксацию <хэш>», где хэш — это SHA отменяемой фиксации.

Тип

Должен быть одним из следующих:

  • build: Изменения, влияющие на систему сборки или внешние зависимости (примеры областей: gulp, broccoli, npm)
  • ci: Изменения в наших файлах конфигурации и сценариях CI (примеры областей: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Только изменения документации
  • feat: Новая функция
  • fix: Исправление ошибки
  • perf: Изменение кода, которое улучшает производительность
  • refactor: Изменение кода, которое не исправляет ошибку и не добавляет функцию
  • style: Изменения, которые не влияют на смысл кода (пробел, форматирование, отсутствующие точки с запятой и т. д.)
  • test: Добавление недостающих тестов или исправление существующих тестов

Тема

Тема содержит краткое описание изменения:

  • используйте повелительное наклонение, настоящее время: «изменить», а не «изменено» или «изменения».
  • не используйте заглавную букву в начале
  • без точки (.) в конце

Тело

Как и в теме, используйте повелительное наклонение, настоящее время: «измените», а не «изменённое» или «изменение». Тело должно включать мотивацию для изменения и противопоставлять его предыдущему поведению.

Нижний колонтитул

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

Критические изменения должны начинаться со слова BREAKING CHANGE: с пробелом или двумя переносами строк. Остальная часть сообщения коммита используется для этого.

Подробное объяснение можно найти в этом документе.

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

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

1
https://api.gitlife.ru/oschina-mirror/mirrors-topology.git
git@api.gitlife.ru:oschina-mirror/mirrors-topology.git
oschina-mirror
mirrors-topology
mirrors-topology
master