1. Введение
В настоящее время большинство компаний используют Git для контроля версий, и каждый программист каждый день вносит код. Многие разработчики, в том числе и я, иногда в спешке или пытаясь избежать проблем, просто отправляют так:
git commit -m "修改bug,优化代码"
Через некоторое время внезапно поищите конкретный коммит, и вы обнаружите, что его не так-то просто найти. Поэтому нам нужно стандартизировать коммиты нашего кода, чтобы избежать этого. В то же время хорошая спецификация отправки также помогает нам создать четкий журнал изменений, который более способствует сотрудничеству между коллегами.
Если вы хотите стать участником известного проекта с открытым исходным кодом, вам необходимо стандартизировать отправку кода.
2. Git подать технические характеристики
В настоящее время в отрасли дела обстоят лучше, и тем более эталонной ценностью является известная интерфейсная структура.AngularJSспецификация подачи. Сначала рассмотрим пример:
Соответствующий формат:
<type>[optional scope]: <description>
# 空行
[optional body]
# 空行
[optional footer]
Более строгие проекты могут представлять описания на английском языке, особенно международные проекты с открытым исходным кодом.
Основываясь на приведенном выше примере, давайте взглянем на эту признанную в отрасли спецификацию отправки Git.
type
refactorУказывает, что это представлениерефакторингкод, т.е. это тип фиксацииtype,Кромеrefactorи:
-
featНовые функции, как следует из названия, являются реализацией новых требований. -
fixИсправление — это исправление ошибки. -
docsДокументация, в основном используется для описания изменений в документации. -
styleВ основном материалы, связанные со стилем кода, такие как форматирование и т. д. -
refactorРеконструкция кода, рефакторинг существующих функций, но различает Bugfix. -
testКоммиты, связанные с тестами, используются реже. -
choreИзменения в процессе сборки или вспомогательные инструменты обычно не используются, например, раньше использовался Maven, а позже был заменен Gradle.
Отправлено по заявлению о подачеtypeОбязательный, он дает понять, что делает этот коммит.
область применения (необязательно)
Он используется для обозначения масштаба воздействия данного представления, что удобно для быстрого позиционирования. Вы можете указать, какой модуль затрагивается (обычно это имя модуля) или какой уровень (уровень данных, сервисный уровень или уровень представления) затрагивается.
subject
выше修改版权信息, представляет собой краткое описание этой фиксации. Точно так же, как толстый брат пишет статью, чтобы у нее был заголовок, не будь слишком длинным.
тело (по желанию)
Стоит подробнее описать элементы, задействованные в этой подаче, и перечислить функции кода.Здесь толстый брат привык пользоватьсяmarkdownсинтаксис списка, то есть отдельные записи с тире-новой строкой. Конечноbodyне требуется, еслиsubjectМожет четко описать.
фут (по желанию)
Описывает, что связано с этой фиксациейbreak changeилиissue.
break change
Укажите, привела ли эта отправка к деструктивным изменениям, таким как обновление версии, уменьшение параметров интерфейса, удаление интерфейса, миграция и т. д. В случае возникновения вышеуказанного воздействия настоятельно рекомендуется указывать в представлении информациюbreak change, что полезно для быстрого обнаружения, отката и сброса при возникновении проблемы.
issue
Если вы обнаружите, что в проекте есть ошибки, или есть предложения по оптимизации, или даже добавить новую задачу, вы можете использовать ее.issueПоставьте задачу в проект.
issueЭто не исключительная функция некоторых платформ Git. Платформы, такие как JIRA, также имеют аналогичные функции. Их функции схожи, и они могут хорошо отражать статус роста и участие в проекте. Затем, когда Git зафиксирует, мы можемfootРегиональные ассоциации, участвующие в подаче заявкиissue.
# 涉及
issues #F12YC,#F45JW
# 关闭
Closes #F12YC
Здесь нет фиксированного формата, но попробуйте для этого обратиться к некоторым известным проектам.
3. Инструменты Амвэй
Сказав все это, я полагаю, что вы уже кое-что знаете о спецификации коммитов Git. Вот несколько полезных инструментов, которые помогут вам реализовать эти спецификации. существуетIntellij IDEAНа рынке плагинов есть много плагинов шаблонов Git Commit Message, которые могут визуально реализовать эти спецификации.
Вы можете перейти на рынок плагинов, чтобы найти похожие плагины. Что ж, сегодняшняя публикация здесь, обратите больше внимания:Код Фермер Маленький Толстый Брат, чтобы узнать больше полезных практических советов по программированию.
关注公众号：Felordcn获取更多资讯