Skip to content

StevenACoffman/commitment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

commitment

Interactive commit message generator for the command line.

Installation

go get -u github.com./StevenACoffman/commitment/cmd/cm

Usage

Commitment (or git-cm) will passthrough any and all the flags you give it to git commit, but then will interactively help you generate a nicely formatted git commit message. If the binary is in your path, then git will add a shortcut to cm for it

So for instance, if you type git cm -s -S -a you will be prompted to optionally pick an emoji, a jira issue, one-line summary, a multiline summary, and a multiline Test Plan.

✔ ✨ - Introducing new features.
📝 Enter your JIRA issue (or hit enter for none).

🤔  Enter your one-line summary:
Add new emoji stuff
✍️  Enter/Paste your multiline summary. On any empty line, Ctrl-D to save it:
I think it will be great
^]
⚗️  Enter/Paste your multiline Test Plan description. On any empty line, Ctrl-D to save it:
Run it and see!
^]

This will result in a commit message like:

✨ Add new emoji stuff

I think it will be great

Issue: none

Test Plan:
Run it and see

About

Interactive commit message generator

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published