Git Product home page Git Product logo

conventional-git-message-py's Introduction

Per repo Git hook commit message validator

  • Validates Conventional Commits' rules 1-6.
  • Ensures short descriptions are not longer than 50 and body lines are not longer than 72.

Conventional Rules Supported

  • Follow the format: type(scope)!: short description followed by an empty line and the body and footer.
  • Type must be one of the following: build, change, chore, ci, deprecate, docs, feat, fix, perf, refactor, remove, revert, security, style, test, version, or wip.
  • (Scope) is an optional noun that describes the code section.
  • The exclamation point is optional and it indicates breaking changes.
Features Description
feat Add feature
remove Remove feature
change Change feature
deprecate Mark feature to be removed
wip Work In Progress. Must be squashed
Other Description
build Update build system files
chore Required periodic changes
ci Update configurations or continuouse integration files
docs Update documentation
fix Fix a bug
perf Improve performance without changing features
refactor Revise code without changing features
revert Remove a problematic commit
security Fix an bug that resolves a security issue
style Revise how code looks
test Update test code
version Bump the version

Requires

  • Bash
  • Python 3
  • A Git repo

conventional-git-message-py's People

Contributors

dkameoka avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.