Usage
Using git-com
Once you’ve installed git-com, and configured a .git-com.yaml file in your repo, making a commit is easy.
Adding new Commits
Just type git com and it will present you with a series of interactive widgets in the order they’ve been specified in the YAML. It’ll show you the commit message it’s about to use, and if you approve the commit will be made with that message.
Amending existing Comits
Add the --amend flag when calling git com and the system will walk you through the interactive widgets just like when creating a new commit. However, it will store the commit body from the commit you’re amending and pre-populate the first multiline-text with a destination of body
What about the normal git tools?
They’re all still there. If - for example - you notice a typo in a commit message you just made, then running the normal git commit --amend is still a great option.
Also, if you just want to make a temporary commit that you’ll add to later, you can use do git commit -m "temp commit" and then use git-com --amend to clean it up later once the commit everything you want in it.
Building on what this creates
Once you’ve got a commit log that’s filled with structured commits, you can start building tooling that leverages that structure to create reports, generate changelogs, find commits that affected a specific section of the codebase.
Check out the Example Tooling page for some ideas.