Skip to main content

git commit on steroids

Project description

pre-commit.ci status Build Status image image

gitorade

background

Tired of dummy commit messages like "fix bug" or "update readme"?

Gitorade is a simple tool for semantically sample and format your git commits and keep a nice clean commit history, and make your fellow developers happy :)

Installation

pip install gitorade

Usage

gitorade <type> -m <message>

For example:

gitorade feat -m "add new feature"

Will generate a commit message like: [feat]: add new feature

Types

  • feat - new feature
  • fix - bug fix
  • docs - changes to documentation
  • style - formatting, missing semi colons, etc; no code change
  • refactor - refactoring production code
  • perf - performance improvement
  • test - adding tests, refactoring test; no production code change
  • chore - updating build tasks, package manager configs, etc; no production code change
  • revert - reverting changes
  • build - changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci - changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • release - version bump
  • other - other changes

License

MIT

Author

Marouane Skandaji

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitorade-1.0.8.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

gitorade-1.0.8-py2.py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page