3 ms·
Tl;Dr: Sometimes, Why is more important than What.
by codegeek 7y ago
Tl;Dr: Sometimes, Why is more important than What.
- pvorb 7y ago"What" is also equally important. But it's covered in the diff itself. Often, there's no need to repeat the diff in text form.
- cborenstein 7y ago+1 that Why matters most. My teammate recently wrote a blog post on how we document Why in git commits and PR descriptions. https://medium.com/better-programming/daily-habits-to-turn-your-git-history-into-valuable-documentation-15113e1bf312 https://medium.com/better-programming/daily-habits-to-turn-y... Would also recommend checking out a related talk by a tech lead at StitchFix: https://confreaks.tv/videos/rubyconf2018-documentation-tradeoffs-and-why-good-commits-matter https://confreaks.tv/videos/rubyconf2018-documentation-trade...