Написание комментариев к коммитам - lanit-tercom-school/grouplock GitHub Wiki

• Следует в каждом коммите делать одно логическое изменение. Если по каким-то причинам изменений больше одного, то необходимо начинать описание каждого изменения с новой строки, а в конце строк (кроме последней) ставить точку с запятой.
• Длина строк основной части сообщения не должна превышать 80 символов.
• Следует описывать изменения от третьего лица или безличным предложением.
• Следует делать сообщения лаконичными, но в то же время точно описывать изменения.
• Следует писать коммиты на английском языке.
• Если Вы решали какую-либо задачу из текущего списка (Issues), следует проставить её номер в сообщении.
• Если необходимо указать какую-либо дополнительную информацию, напишите её после основного сообщения, оставив пустую строку.

Хорошо:
Issue #3 - Fixed bug in login form;
Removed deprecated class AnotherClass

Important: After merge with master branch modules that use AnotherClass will not work anymore. Make sure to remove all dependencies before v1.2 release.


Плохо:
I added new method in my SomeClass
I also fixed some bugs and removed some deprecated stuff