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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

Details for the file gitorade-1.0.8.tar.gz.

File metadata

  • Download URL: gitorade-1.0.8.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for gitorade-1.0.8.tar.gz
Algorithm Hash digest
SHA256 c8f56e54724d5bbee49785a70e674b9da991c3729223e989a2ee3161337058ca
MD5 6b820fc36ffba86bbb41b968a068119f
BLAKE2b-256 07a9dab0f31844a095b20f70dd413fab82c3b13ebb2db7546bb0a7e5fded9b0f

See more details on using hashes here.

File details

Details for the file gitorade-1.0.8-py2.py3-none-any.whl.

File metadata

  • Download URL: gitorade-1.0.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.13

File hashes

Hashes for gitorade-1.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 61cf1af87edfe962c85dab65fa1582e101f9770d009cb4fda066ddaeb581411c
MD5 65dfbccbe978a61dec4bfdf680e86a9d
BLAKE2b-256 d003cf82d25a30e69bf5c84c92fa095a2e9bc0d04ceb8fae990beab142aee423

See more details on using hashes here.

Supported by

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