You must-know guide for writing proper git messages!

1. How to write proper
git commit messages
Hanokh.Aloni@gmail.com

2. Git commit -m”...?”

3. @hanokhaloni
Hanokhaloni
hanokhaloni

4. git log --oneline
a6455f8 bugfix
b529f6d revert the bugfix
b5bb6e4 revert "revert the bugfix"
c829cbc more fix
5feaccf wip
5ba3db6 wip
84564a0 add files
e142fd1 do stuff

5. git log --oneline
a6455f8 aaaaaaaaaaaaaaaaaa
b529f6d YOLO
b5bb6e4 fix tpyo
c829cbc more fix
5feaccf Whatever
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Committing in accordance with the prophecy.

6. Why do we need a good commit
message?
Git let’s you time travel
So you need to know where you want to travel to
In terms of who did what , and when?

7. What makes a good commit
message?

8. Git history should be human-readable, in the
past-tense, and explain what was changed.
a6455f8 aaaaaaaaaaaaaaaaaa
b529f6d YOLO
b5bb6e4 fix tpyo
c829cbc more fix
5feaccf Updated readme.md
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Updated gitlab.yaml

9. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 aaaaaaaaaaaaaaaaaa
b529f6d YOLO
b5bb6e4 fix tpyo
c829cbc more fix
5feaccf Whatever
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Committing in accordance with the prophecy.

10. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel
b529f6d YOLO
b5bb6e4 fix tpyo
c829cbc more fix
5feaccf Whatever
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Committing in accordance with the prophecy.

11. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel
b529f6d Introduced the decision engine
b5bb6e4 fix tpyo
c829cbc more fix
5feaccf Whatever
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Committing in accordance with the prophecy.

12. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel
b529f6d Introduced the decision engine
b5bb6e4 Allowed course description page
c829cbc more fix
5feaccf Whatever
5ba3db6 Removed unused fields
84564a0 docs
e142fd1 Committing in accordance with the prophecy.

13. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel
b529f6d Introduced the decision engine
b5bb6e4 Allowed course description page
C829cbc Fixed a bug
5feaccf Updated lodash
5ba3db6 Removed unused fields
84564a0 Updated docbook and user guide
e142fd1 Add tests

14. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel
b529f6d Introduced the decision engine
b5bb6e4 Allowed course description page
C829cbc Fixed a bug
5feaccf Updated lodash
5ba3db6 Removed unused fields
84564a0 Updated docbook and user guide
e142fd1 Add tests

15. Git history should be human-readable, in
the past-tense, and explain what was
changed.
a6455f8 Added side panel to front page.
b529f6d Introduced the decision engine.
b5bb6e4 Allowed invited users to see the course description page.
c829cbc Fix : Send enrolment invitation emails in batches of 1000.
5feaccf Updated lodash to v4.17.21
5ba3db6 Removed unused fields on the User model
84564a0 Updated docbook and user guide
e142fd1 Add tests for ImportSelector metadata

16. Some keywords you should be able to use
Add
Create
Refactor
Fix
Release
Feature
Performance
Modify
Update
Remove
Delete
Docs
Test
Style

17. Some keywords you should be able to use
Add
Create
Refactor
Fix
Release
Feature
Performance
Modify
Update
Remove
Delete
Docs
Test
Style

18. Git history should be human-readable, in the
past-tense, and explain what was changed.
a6455f8 feat: Added side panel to front page.
b529f6d feat: Introduced the decision engine.
b5bb6e4 feat: Allowed invited users to see the course description page.
c829cbc fix: Send enrolment invitation emails in batches of 1000.
5feaccf refactor: Updated lodash to v4.17.21
5ba3db6 refactor: Removed unused fields on the User model
84564a0 docs: Updated docbook and user guide
e142fd1 test: Add tests for ImportSelector metadata

19. Bonus - trace back to your JIRA / task
a6455f8 feat: Added side panel to front page (ARDA-711)
b529f6d feat: Introduced the decision engine (ARDA-712)
b5bb6e4 feat: Allowed invited users to see the course description page (ARDA-35)
c829cbc fix: Send enrolment invitation emails in batches of 1000 (ARDA-730)
5feaccf refactor: Updated lodash to v4.17.21 (ARDA-690)
5ba3db6 refactor: Removed unused fields on the User model (ARDA-714)
84564a0 docs: Updated docbook and user guide (ARDA-715)
e142fd1 test: Add tests for ImportSelector metadata (ARDA-716)

20. Stuck? Just ask yourself the following
questions:
Why have I made these changes?
What effect have my changes made?
Why was the change needed?
What are the changes in reference to?

21. commit eb0b56b19017ab5c16c745e6da39c53126924ed6
Author: Pieter Wuille <pieter.wuille@gmail.com>
Date: Fri Aug 1 22:57:55 2014 +0200
Simplify serialize.h's exception handling (#145)
Remove the 'state' and 'exceptmask' from serialize.h's stream
implementations, as well as related methods.
As exceptmask always included 'failbit', and setstate was
always
called with bits = failbit, all it did was immediately raise an
exception. Get rid of those variables, and replace the setstate
with direct exception throwing (which also removes some
dead
code).
As a result, good() is never reached after a failure (there are
only 2 calls, one of which is in tests), and can just be replaced
by !eof().
fail(), clear(n) and exceptions() are just never called. Delete
them.
https://github.com/bitcoin/bitcoin/co
mmit/eb0b56b19017ab5c16c745e6
da39c53126924ed6

22. Some tools that can help - commitizen

23. Some tools that can help - commitlint

24. Oh, you can also rewrite history if you need!

25. Oh, you can also rewrite history if you need!

26. Git history should be :
- Human-readable.
- In the past-tense.
- Explain what was changed.
Use keywords.
Bonus points for reference (JIRA / issue #).
Use tools like commitzen and commitlint.
Fix it if you need to (rewrite history if needed)

27. Links
http://whatthecommit.com/
https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-
History
https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
https://github.com/commitizen/cz-cli

28. @hanokhaloni
Hanokhaloni
hanokhaloni