git plan

A better workflow for git.

Git plan inverts the git workflow so that you can write your commit message first, before you start writing code. This makes it easier to plan your work and stay on-track.

To use the tool, run git plan init (or simply gp [command]) to initialize, and then git plan add to plan a new commit. Then when you have finished writing the code, use git plan commit to use the plan as a template for your commit message.

This tool is in early alpha stage, so be careful and please make an issue or let me know if anything breaks.

Installation

python3.8 is required for now.

1. git clone https://github.com/synek/git-plan
2. cd git-plan
3. make install

If you have trouble with the install, check what the Makefile is doing. Get in touch with me if you need help.

To uninstall, run make uninstall

Usage

• git plan init - initialize git plan in the current .git/ directory
• git plan [--long] - plan your first commit, or list existing plans
• git plan help - show the help message
• git plan list [--long] - list existing plans
• git plan add - plan a new commit
• git plan edit - edit an existing plan
• git plan delete - delete an existing plan
• git plan commit - commit one of your plans (launches git commit with your plan as a template)

Background

Here is an interesting blog post about pre-emptive commit comments.

Contributing

• Download and try it out
• Create an issue if you find a problem or want to discuss something
• Fork the repository, fix a bug or add a feature, and open a PR

Development

1. Install the dev requirements pip install -r requirements_dev.txt
2. Install the package in develop mode pip install -e .
3. Install the pre-commit hooks pre-commit install -t pre-commit and pre-commit install -t pre-push

Hooks

Failure on any of the hooks will prevent the action taking place.

Pre-Commit

• pylint on changed source files
• mypy on changed source files

Pre-Push

• tox test suite runs