Metadata-Version: 2.1
Name: commit-msg-hook
Version: 0.2.9
Summary: Checks if commit message matches the chaos-hub commit rules
Home-page: https://github.com/dimaka-wix/commit-msg-hook.git
Author: Dima Karpukhin
Author-email: dimaka@wix.com
License: MIT
Description: # commit-msg-hook
        This hook is made as a custom plugin under the [pre-commit](https://pre-commit.com/) hook framework and checks if commit message matches the chaos-hub team commit rules.
        
        ## Installation 
        ```
        pip install commit-msg-hook
        ```
        ## Using commit-msg-hook with pre-commit 
        
        For more details see: [pre-commit](https://pre-commit.com/)
        ### Install pre-commit package manager 
        ```
        pip install pre-commit
        ```
        
        
        ### Create a file ```.pre-commit-config.yaml``` in the root folder with the following configuration
        ```
        - repo: https://github.com/dimaka-wix/commit-msg-hook.git
          rev: v0.2.9
          hooks:
            - id: commit-msg-hook
              stages: [commit-msg]
        ```
        ### To enable commit-msg hook with pre-commit run:
        ```
        pre-commit install --hook-type commit-msg
        ```
        ### Update to the latest release (optional)
        ```
        pre-commit autoupdate --repo https://github.com/dimaka-wix/commit-msg-hook.git
        ```
        ### Commit Rules
        
        * _Write up to **72** characters(preventing ellipsis in git)_
        * _Capitalize the subject line_
        * _Do not end the subject line with any punctuation character_
        * _Use the imperative mood(e.g. **Add** instead of **Added** or **Adds**)_
        * _Use the description to explain what and why vs how_
        * _Press **Shift+Enter** to create a new line and to write more characters then vscode lets you_
        * _**Separate subject from body with a blank line!**_
        
        
        #### Example
        ```
        Refactor Z function in X file from Y component
        
        * Fix ...
        * Add ...
        * Update ...
         ```
         ### Bypass the hook in one of the following ways
        - ```SKIP=commit-msg-hook git commit -m "Your message"```
        - ```git commit -m "Your message" --no-verify```
        - ```git commit -m "Your message" -n (not recommended)```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
