Стандарт, который следует соблюдать при написании сообщений git commit [дубликат]

этот вопрос уже есть ответ здесь:

  • Git Commit Messages: 50/72 Форматирование 4 ответы

я обнаружил, что управляю очень многими файлами (более 60, но ниже 70), и мои сообщения о фиксации до сих пор следуют этой схеме: когда я добавил что-то вроде О layout.css, мое сообщение фиксации " добавлено что-то на макет.стиль CSS файл", и когда я удаляю что-то, мое сообщение фиксации "удалить что-то из макета.css-файл".

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

есть ли стандарт, который я должен следовать, чтобы помочь мне подняться с моего сообщения?

3 72
github commit-message git-commit

3 ответа:

когда вы просто описываете то, что вы сделали (в технических, но нечетких терминах, таких как "добавлена функция"), вы не добавляете много к тому, что Git уже хранит в фиксации. Представьте себе, что Вы читаете сообщение о фиксации некоторое время спустя; какое резюме поможет вам больше всего запомнить / сообщить другим разработчикам суть этого изменения?! Точное содержание зависит от вашего проекта и процессов, но я считаю, что хорошим ориентиром.

в первую очередь добавить контексте (почему, а не как) С вашим сообщением фиксации (например, "frobnize сообщение, чтобы включить сохранение") вместо "добавлена функция frob ()"). Это больше усилий (вы должны задуматься и думаю), но стоит гораздо больше.

Если вы хотите изучить больше об этой теме, есть много информации, например в этой статье блога Петр Hutterer или этот забавный слайд.

72

модель 50/72 кажется хорошей практикой. то есть ... первая строка должна быть длиной не более 50 символов и должна быть сервером в качестве заголовка. Затем следует пробел, второй набор строк должен быть обернут в 72 символа и должен служить в качестве резюме. Вот такой вопрос : Git Commit Messages: 50/72 Форматирование, что обсуждается то же самое.

вот некоторые исчерпывающие замечания по этому вопросу:

  1. GIT Commit Good Practice
  2. Примечание О Git Commit Messages
  3. правильный Git фиксирует сообщения и элегантную историю Git
40

Git уже знает, какие файлы вы изменили в фиксации, бесполезно указывать его в комментарии. Просто скажите, например, "Исправлена ошибка заполнения"или" добавлено меню в боковой панели". Дай мне понять, вот и все.

9