Closed RootenberG closed 5 years ago
Extend the commit message with a longer description explaining what it does more precisely.
Extend the commit message with a longer description explaining what it does more precisely.
But everyone can see the list of changes using the git log -p
command, I think it is not difficult to understand what is happening.
People rarely look at patch contents before checking the commits list. The history should make sense to attract the reader to certain commit so that they'd look into it closer.
to simplify the work on the project
It sounds like an advertisement "hey, apply this cool commit", but you're not writing a novel.
This is too abstract. Be more pragmatic. Explain how this commit is useful on the high level.
It should add value. For obvious things like these configs controlling Git behavior you don't need to explain what they do — the reader already uses Git and they either already know what those files are or know where to find such info.
I'd do something like this:
Create initial git config files
Specify:
* .gitignore
* .gitatributes
Also, let's do #14 before merging this
Now squash related changes and let's wait for #14
Let's merge #12 first
Closes #6