jamsyoung / git-commit-helper

Git Commit Helper

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Git Commit Helper

This will be a plug-in for git to allow for a custom interactive commit, which is useful for teams that want commit messages to adhere to a specific format. This is originally being written to work with changelog-maker. This project was inspired by commitizen.

I am not sure who came up with the commit guidelines that the changelog-maker parses, but I first ran across it on the Node.js project. You can read about there in their CONTRIBUTING.md, which is extremely similar to the one in this repository as well.

Theoretical Usage

$ git [something-other-than-`commit`]

? Choose a subsystem:
> subsystem-a-defined-in-a-config-file
> subsystem-b
> sybsystem-c
...

? Brief description: (single line)
>

? Detailed description: (multiple lines)
>

? Fixes:
> [list of open github issues on repo]

The commit would look like this:

subsytem-b: brief description

Detailed description.

Fixes: #3
Reviewed-By: Your Name <your.email@address.com>

About

Git Commit Helper

License:MIT License


Languages

Language:JavaScript 100.0%