https://github.com/soerenschneider/conventional-pre-commit-hook

Hook for pre-commit that checks whether commit messages are formatted adhering to conventional commits.
https://github.com/soerenschneider/conventional-pre-commit-hook

conventional-commit conventional-commits git git-hook git-hooks pre-commit pre-commit-hook semantic-commits

Last synced: 11 months ago
JSON representation

Hook for pre-commit that checks whether commit messages are formatted adhering to conventional commits.

• Host: GitHub
• URL: https://github.com/soerenschneider/conventional-pre-commit-hook
• Owner: soerenschneider
• License: apache-2.0
• Created: 2021-10-10T09:11:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-10T17:34:20.000Z (over 4 years ago)
• Last Synced: 2025-02-06T05:23:41.159Z (about 1 year ago)
• Topics: conventional-commit, conventional-commits, git, git-hook, git-hooks, pre-commit, pre-commit-hook, semantic-commits
• Language: Shell
• Homepage:
• Size: 245 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# conventional-pre-commit-hook

Hook for [pre-commit](https://pre-commit.com/) that checks whether commit messages are formatted adhering to [conventional commits](https://www.conventionalcommits.org).

## Installation

If you're not already using pre-commit, create a `.pre-commit-config.yaml` file in your repository with the following content 

```yaml

---

repos:

  - repo: https://github.com/soerenschneider/conventional-pre-commit-hook

    rev: v1.0.0

    hooks:

      - id: conventional-commit

 ```

 

 Initialize pre-commit using `pre-commit install --hook-type commit-msg`

 

 ## Demo

 ![demo](demo.gif)