Metadata-Version: 2.1
Name: enforce-git-message
Version: 1.0.0
Summary: Enforces conventional git commit messages for git repositories
Home-page: https://github.com/prahladyeri/enforce-git-message
Author: Prahlad Yeri
Author-email: prahladyeri@yahoo.com
License: MIT
Description: ![pypi](https://img.shields.io/pypi/v/enforce-git-message.svg)
        ![python](https://img.shields.io/pypi/pyversions/enforce-git-message.svg)
        ![implementation](https://img.shields.io/pypi/implementation/enforce-git-message.svg)
        <!-- https://img.shields.io/travis/prahladyeri/enforce-git-message/master.svg -->
        <!-- ![docs](https://readthedocs.org/projects/enforce-git-message/badge/?version=latest) -->
        ![license](https://img.shields.io/github/license/prahladyeri/enforce-git-message.svg)
        ![last-commit](https://img.shields.io/github/last-commit/prahladyeri/enforce-git-message.svg)
        <!--![commit-activity](https://img.shields.io/github/commit-activity/w/prahladyeri/enforce-git-message.svg)-->
        [![follow](https://img.shields.io/twitter/follow/prahladyeri.svg?style=social)](https://twitter.com/prahladyeri)
        # enforce-git-message
        
        Enforces [conventional git commit messages](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) for all new git repositories you create by running `git init .`. For existing repositories, you can go to your source directory and simply run:
        
        	enforce-git-message .
        
        # Installation
        
        	pip install enforce-git-message
        	
        	
        # Verifying
        
        Go to your source folder and try to commit with a non-conventional message like this and it should fail:
        
        	> git commit -m "added a new feature for xyz"
        	Traceback (most recent call last):
        	  File "C:/Users/prahlad/Documents/scripts/check_commit.py", line 14, in <module>
        		main()
        	  File "C:/Users/prahlad/Documents/scripts/check_commit.py", line 11, in main
        		if m == None: raise Exception("conventional commit validation failed")
        	Exception: conventional commit validation failed
        	
        After that, try doing the commit with a valid message and it should work:
        
        	> git commit -m "feat(test): added xyz"
        	>
        	
        
Keywords: security,scanner
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >= 3.4
Description-Content-Type: text/markdown
