Commits

Have you looked at a PR on a project that long, complex, and touched many files? I'm not a fan of reviewing these, and I suspect you aren't either.

For projects I'm on, I want commits like this:

• Small — I can carry context in my head, and understand the change
• A good commit message — should:
  • Follow standard Git recommendations. One of many examples is from Toni Cardina Bardos who summarizes common advice. See the official Git documentation. This is a good discussion with contributors to your project
  • Be sensible for others
    
• Be able to easily check the build pipeline for every commit

Tips

• For command-line commits, out-of-the-box vim does very well when opened with a simple git commit. When in "visual" (full terminal) mode, vim colorizes for you when you break recommendations on formatting for a commit message.

Going further

TODO: Placeholder section