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

OSCHINA-MIRROR/ant-design-blazor-ant-design-blazor

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

Разработка и тестирование программного обеспечения: рекомендации по работе с кодовой базой

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

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

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

Прежде чем отправить запрос на включение (Pull Request, PR), рассмотрите следующие рекомендации:

  • Найдите на GitHub открытый или закрытый PR, который относится к вашей отправке. Вы не хотите дублировать усилия.
  • Внесите изменения в новую ветку git:
git checkout -b my-fix-branch master
  • Создайте патч, включая соответствующие тестовые случаи.
  • Следуйте нашим правилам кодирования.
  • Запустите полный набор тестов ant-design-blazor (описано в [документации разработчика][dev-doc]) и убедитесь, что все тесты пройдены.
  • Подтвердите свои изменения с помощью описательного сообщения о фиксации, которое соответствует нашим соглашениям о фиксации. Соблюдение этих соглашений необходимо, поскольку примечания к выпуску автоматически генерируются из этих сообщений.
git commit -a

Примечание: необязательная опция командной строки -a автоматически «добавит» и «удалит» отредактированные файлы.

  • Отправьте свою ветку на GitHub:
git push origin my-fix-branch
  • На GitHub отправьте запрос на вытягивание в ant-design-blazor:master.
  • Если мы предложим изменения, то:
    • Внесите необходимые обновления.
    • Повторно запустите наборы тестов ant-design-blazor, чтобы убедиться, что тесты всё ещё пройдены.
    • Перебазируйте свою ветку и принудительно отправьте её в свой репозиторий GitHub (это обновит ваш запрос на включение):
git rebase master -i
git push -f

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

После объединения вашего запроса на включение

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

  • Удалите удалённую ветку на 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 commit. Это приводит к более читаемым сообщениям, которые легко отслеживать при просмотре истории проекта. Между тем, мы используем сообщения git commit для создания журнала изменений ant-design-blazor.

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

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

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

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

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

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

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

docs(changelog): update change log to beta.5
fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need **Формат сообщения о фиксации изменений**

Последние из них.  

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

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

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

Вот несколько примеров:
* module:alert;
* module:badge;
* module:breadcrumb;
* module:OTHER_COMPONENT_NAME.

В настоящее время существует несколько исключений из правила «использовать имя модуля»:
* **packaging**: используется для изменений, которые изменяют макет пакета npm, например, изменения общедоступного пути, изменения package.json, изменения формата файла d.ts, изменения пакетов и т.д.;
* **changelog**: используется для обновления примечаний к выпуску в CHANGELOG.md;
* **showcase**: используется для связанных с docs-app (ng.ant.design) изменений в каталоге showcase / репозитория;
* none/пустая строка: полезна для style, test и refactor изменений, которые выполняются во всех пакетах (например, style: добавить отсутствующие точки с запятой).

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

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

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

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

Подробное объяснение можно найти в этом [документе][commit-message-format].

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

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

1
https://api.gitlife.ru/oschina-mirror/ant-design-blazor-ant-design-blazor.git
git@api.gitlife.ru:oschina-mirror/ant-design-blazor-ant-design-blazor.git
oschina-mirror
ant-design-blazor-ant-design-blazor
ant-design-blazor-ant-design-blazor
master