#devnote

"If Astarion romances Karlach, it will be a little harsher, a little more jagged than other romances in their repartee and Karlach's decision to stay with him. They are very different, but Karlach will be drawn to his charisma and the deep heart beneath the wickedness. They have similar histories and a lot in common, but it won't be a sweet perfect love - it will be complicated."

Like damn, someone on the team looked at those two and the complexities of their relationship and got hit BAD. Same honestly.

The git log command can be a very useful tool to tell a clear story of the evolution of your Software. In fact, a single read though it can be enough to understand the how and the why of the current state of your project. Take into account the following options:

Follow a chronological order

Commit the changes in a chronological sensible order. Commits focusing on related components of your application should be recorded one after another. Following the history of a file should be as smooth as possible.

Use a clear redaction

Use both, the short and the long message features of the commit command to record a clear explanation of what, how and why has changed. Don't be afraid of being verbose. Reading the messages should be enough to understand a change, and using the diff tool should no longer be necessary.

Stay in context

Separate the commits by type and context: a refactor, a fix, a typo correction. Separate actual logic changes from coding style changes.

Branch off

By branching off, you create a sub-story of a certain change. The merge commit then indicates when that sub-story crossed paths with the main story.

A learning tool

Good organized commits can be used to teach and to learn. Think of it as a step-by-step tutorial, tracking the exact changes of a component.

Useful tools:

# Git commands git add --patch git add --interactive git commit --amend/--interactive/--squash/--fixup git rebase --interactive # Pretty log alias: git log --pretty='format:%Cgreen%h%Creset %s' --graph

After all, which of the following logs tells you a better story:

This?

Or this: