Commit messages

Transcript

1. Комментарии к коммитам
2. Зачем? • Научиться ставить задачи по проекту • Научиться выделять код для коммита • Быстро получить список изменений для нового релиза • Подготовить отчет • Быстро найти ошибку
3. Сейчас http://whatthecommit.com/ • lots and lots of changes • oops, forgot to add the file • fixed errors in the previous commit • /sigh/test.py • I don't get paid enough for this shit • Moved something to somewhere... goodnight...
4. Шаблоны для английского языка • Add new feature - добавление новой возможности • Fix - исправление ошибки • Change task - изменения в текущем коде • Update - исправления в связи с изменениями в другом коде • Improve - улучшения в текущем коде • Move - перенос файлов, кода • Remove - избавление от (удаление) ненужных файлов или кода
5. Шаблоны для русского языка • Добавлена новая возможность • Исправлена ошибка • Изменена работа • Исправлено согласно изменениям в... • Улучшена работа • Файл (код) перенесен • Удален файл (код)
6. Текст комментария • Может быть похож на заголовок Issue (проблемы) • Описание того, что было исправлено
7. Примеры • Add image_src for social networks • Fix news detail image_src • Change search algorithms for topics and regions • Update bootstrap: styles for tables • Improve deletion from feed • Move organizations_alphabet templatetag in details_short template • Remove div tags from content https://github.com/
8. Сложные проекты https://github.com/torvalds/linux app_name: commit message Пример: ARM: omap: fix broken twl-core dependencies and ifdefs
9. спасибо