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.
python3.8 is required for now.
git clone https://github.com/synek/git-plancd git-planmake 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
git plan init- initialize git plan in the current .git/ directorygit plan [--long]- plan your first commit, or list existing plansgit plan help- show the help messagegit plan list [--long]- list existing plansgit plan add- plan a new commitgit plan edit- edit an existing plangit plan delete- delete an existing plangit plan commit- commit one of your plans (launchesgit commitwith your plan as a template)
Here is an interesting blog post about pre-emptive commit comments.
Give me a shout - rory@rory.bio or @ryrobyrne