Как разработчики, мы часто сталкиваемся с трудностями при написании комментариев git, когда мы коммитим наш код. В результате письменные комментарии часто игнорируются, и пишутся случайные комментарии.
В этой короткой, но полезной статье я дам вам начальное руководство по написанию кода в наших коммитах. Предварительные условия этого столбца требуют базового использования команд git, GitHub и IDE, поэтому давайте начнем.
- Новая функция. Предположим, я работаю над новой функцией в каком-либо приложении и хочу ее опубликовать, тогда мы можем зафиксировать ее с помощью git commit -m «‹custom comment›».
Здесь для новой функции мы можем написать это как «подвиг: добавлены новые компоненты». Таким образом, итоговая команда будет следующей: -
git commit -m «feat: добавлены новые компоненты»
2. Разрешение ошибок. Посмотрим правде в глаза, мы не можем избежать ошибок. После устранения ошибки мы можем отправить исправление ошибки с комментарием фиксации «исправить:‹запись ошибки›». Например, если мы работали над кодом, который получается из-за отсутствия круглых скобок, мы делаем это, используя
git commit -m “fix : отсутствуют скобки
3. Рефакторинг. Предположим, вы работаете над React JSX, и вам нужно реорганизовать все приложение React в машинописный текст (TSX). Затем вы можете взять от 4 до 5 файлов проекта, преобразовать их в React TSX, внести изменения внутри файлов и зафиксировать. Причина использования 4-5 файлов в каждом коммите заключается в его осуществимости, и мы знаем, какие изменения вносятся, иначе будет сложно отладить, если рефакторинг сломает приложение.
Пример комментария фиксации рефакторинга может быть таким
git commit -m «refactor: JSX-›TSX компонент A, B,C»
4. Зависимость — вы установили некоторые библиотеки npm, такие как moment.js или другие библиотеки, которые необходимы для выполнения вашей работы, и хотите зафиксировать их, после чего вы сможете их использовать. Например, если вам дали работу с датой и временем, и вы добавили библиотеку moment.js для управления датами, а в первый день вы добавили только библиотеку, которой нет в репозитории разработки, и хотите поместить библиотеку в свой репозиторий, тогда вы может использовать это
git commit -m «зависимость: добавлен момент.js»
Резюме
Правило комментирования можно резюмировать одной строкой.
«глагол: ‹краткое резюме›»
Глагол — работа, которую вы пытаетесь выполнить, т. е. — (добавить, реорганизовать, исправить, зависеть)
Краткое резюме — краткая версия того, что вы включили в одну строку, обычно в прошедшем времени.
Надеюсь, вы получили новую информацию о комментариях git.
