Giter Club home page Giter Club logo

pre-commit-msg's Introduction

pre-commit-msg tag python Build pre-commit

A collection of prepare message and commit message git hooks for use with the pre-commit framework. For details see the list of available hooks below.

Using pre-commit-msg with pre-commit

Add this to your .pre-commit-config.yaml:

    -   repo: https://github.com/boidolr/pre-commit-msg
        rev: v1.3.1  # Use the ref you want to point at
        hooks:
        -   id: format-message
        # -   id: ...

For an extended example see .pre-commit-config.yaml.

Available hooks

  • prepare-message: Change commit messages to include a prefix.
    • --ignore-branch will lead to the branch not being checked.
    • --pattern can be used to change the feature branch pattern to take the message prefix from. Needs to match with --prefix-pattern. Defaults to feature/(\w+-\d+).
    • --prefix-pattern should match the prefix of the message to normalize it. Needs to match with --pattern. Defaults to ^\s*\w+-\d+\s*:
  • format-message: Ensure commit message conforms to format of headline followed by two empty lines.
    • --capitalize if the subject line should be capitalized. Other lines remain unchanged.

pre-commit-msg's People

Contributors

boidolr avatar github-actions[bot] avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar  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.