search

pgr0ss / rake_commit

A program that helps with checking in code. It automates common git or svn commands.
13 stars 13 forks source link

Add optional alternative 'what & why' prompts. #26

Closed leighmcculloch closed 8 years ago

leighmcculloch commented 8 years ago

What

Optionally collect the git message as what, why and a short subject line. Only used by the Git integration. Long messages are word wrapped, default off.

Why

So that users can optionally use this format instead of entering a single block commit message. Limiting commit messages to have a single what accompanied by a why supports a third party looking at the diff know what the intentions and reasons for the change were without needing to hypothesise.

pgr0ss commented 8 years ago

This is an interesting feature. I'm curious if other people would use it as well.

leighmcculloch commented 8 years ago

@pgr0ss I'd like to break this PR into two PRs, one that is a no-op and does the refactoring and changes nothing about the functionality, then one that adds the what & why. It'd be a PR of just the first four commits.

leighmcculloch commented 8 years ago

@pgr0ss i've moved the refactor changes into #27 so they can be discussed and merged by themselves and reduce the chance of regression.

pgr0ss commented 8 years ago

I merged in the other pull requests. Do you mind rebasing this PR to make it easier to review and to see if the tests pass? Thanks!

leighmcculloch commented 8 years ago

@pgr0ss I rebased and looks like we have :green_heart:. Don't merge it just yet, I want to test a couple more things.