Preemptive commit comments | Arialdo Martini - 0 views
arialdomartini.wordpress.com/...pre-emptive-commit-comments
BDD BehaviorDrivenDevelopment CommitComment BestPractices SoftwareEngineering

-
Tell me what the software does
-
kuni katsuya on 15 Mar 13tell me how the software should *behave*, not how the behavior was *implemented* ie. describe the changes in this commit from the behavioral perspective rather than implementation details
-
- ...43 more annotations...
-
No more “Just a fix“, “Improvements” or “I made this, this, this and also this” comments.
-
A preemptive comment sets a micro goal
-
Without preemptive comments, I often went on coding, always asking myself: “Should I commit now? Have I reached a stable state which I could consider a good commit?“
-
A preemptive comment creates a little timebox
-
Writing comments preemptively puts the agreement between the pair members to a test
-
feature branch becomes a collection of evolutionary commits each of which has usually a 1:1 binding with tests
-
very easy to find which commit introduced a bug, since each commit is related to a single new goal/feature
-
I started taking a lot of care of the words I was using in comments, commits, test names and classes/variables/methods’ names