Я хочу предложить более наглядную форму сообщений git commit.
Сообщение фиксации, написанное на текущем распространенном диалекте, описывает «что» изменилось. Однако чаще всего сам код является лучшим описанием этого «чего». Заголовок сообщения фиксации лучше описывает намерение изменения. Он должен обосновать необходимость этого изменения в целях достаточно высокого уровня для предполагаемого рецензента. Он должен ответить на самый важный вопрос, заданный рецензентом, то есть «почему вы внесли это изменение?», А не «что было изменено в этом коммите?»
Начало сообщения фиксации с фразы, подобной «Я хочу», убеждает автора сформулировать свою основную мотивацию. Это показывает, чего на самом деле хотел добиться автор в этом изменении.
Давайте посмотрим на знакомое сообщение коммита:
Зарегистрируйте cleanupFuncs и вызовите их на Close
Это сообщение просто перефразирует то, что на самом деле уже доступно в diff. Давайте перепишем это сообщение, указав основную мотивацию, чтобы вместо этого ответить на вопрос «почему»:
Я хочу, чтобы каждая часть кода отвечала за свои собственные методы очистки
Это увеличит длину коммита, но я думаю, что выгода стоит дополнительных персонажей.
Начало коммита с «Я хочу» помогает другим разработчикам и рецензентам сформировать целостное понимание изменения и с меньшими трудностями разобраться в нем.
