2017 © Pedro Peláez
 

project proofr

image

aaronjameslang/proofr

  • Saturday, July 28, 2018
  • by aaronjameslang
  • Repository
  • 1 Watchers
  • 2 Stars
  • 16 Installations
  • Shell
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 13 Versions
  • 0 % Grown

The README.md

proofr Build Status

Git hook to check conformance to http://chris.beams.io/posts/git-commit/, (*1)

Do you or your collaborators have trouble remembering how to format your commit messages? Try proofr., (*2)

proofr integrates seamlessly into your workflow: - if you write a compliant commit message, you won't even know it's there - if you write a noncompliant commit message, the commit will fail and you'll receive feedback: $: git commit --allow-empty --message 'fixed it.' Capitalize the subject line Do not end the subject line with a period Use the imperative mood in the subject line $:, (*3)

The seven rules of a great git commit message

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Installation

Homebrew/Linuxbrew

brew installaaronjameslang/tap/proofr, (*4)

Composer/Packagist

composer [global] requireaaronjameslang/proofr, (*5)

Setup

cd my-project && proofr setup, (*6)

This will add proofr to the commit-msg hook of your project, (*7)

How proofr works

After each commit message you write, git will call .git/hooks/commit-msg and pass in the commit message as the first parameter. You can make commit-msg anything you like so long as it - Calls proofr - Passes proofr it's first argument - Deals with proofr's exit code - Is executable, (*8)

For background see http://githooks.com, (*9)

Compatibility

Should work on most *nixes, including GNU/Linux, Mac OSX, and Windows Subsystem for Linux, (*10)

If you are unsure of compatibilty with your system, run make. If your system is incompatible, please open an issue., (*11)

Contribution

Suggestions, bug reports and pull requests are all welcome. Please open an issue and get feedback before beginning a pull request., (*12)

Design Decisions

  • The tests were originally written using roundup, however this dependency was dropped to make it easier for users to run the tests on their machines

The Versions

28/07 2018

dev-test-bsd

dev-test-bsd

  Sources   Download

30/03 2018

1.0.0

1.0.0.0

  Sources   Download

09/04 2017

dev-master

9999999-dev

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

09/04 2017

2.2.0

2.2.0.0

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

04/04 2017

2.1.0

2.1.0.0

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

02/04 2017

dev-04-no-period

dev-04-no-period

  Sources   Download

02/04 2017

dev-speed

dev-speed

  Sources   Download

02/04 2017

dev-develop

dev-develop

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

02/04 2017

2.0.0

2.0.0.0

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

02/04 2017

dev-rebrand

dev-rebrand

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

01/04 2017

dev-readme

dev-readme

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

01/04 2017

1.2.0

1.2.0.0

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce

01/04 2017

1.1.0

1.1.0.0

Git hook to check conformance to http://chris.beams.io/posts/git-commit/

  Sources   Download

MIT

by Aaron J. Lang

hook git style lint message standards commit enforce