File tree Expand file tree Collapse file tree 2 files changed +17
-7
lines changed
Expand file tree Collapse file tree 2 files changed +17
-7
lines changed Original file line number Diff line number Diff line change 55![ downloads] ( https://img.shields.io/pypi/dm/commit-linter?style=flat-square )
66![ PyPI - Wheel] ( https://img.shields.io/pypi/wheel/commit-linter )
77![ PyPI - Implementation] ( https://img.shields.io/pypi/implementation/commit-linter )
8- <!--  -->
98![ PyPI - Format] ( https://img.shields.io/pypi/format/commit-linter )
109[ ![ Conventional Commits] ( https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg )] ( https://conventionalcommits.org )
1110
@@ -39,6 +38,17 @@ if you want to remove the hook, just execute
3938commit-linter remove
4039```
4140
41+ ## How it works
42+
43+ commit-linter uses git-hooks which are scripts that exists in each repository.
44+ Take a look at any repo you have, you will have ` .git ` directory, and inside you
45+ will find ` hooks ` directory, commit-linter just puts a simple script named ` commit-msg `
46+ inside that directory and makes it executable so each time you right a commit message
47+ it will get linted as per the conventions, you can look at script in your repository
48+ inside ` .git/hooks ` path.
49+
50+ Read more about [ Git Hooks] ( https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks ) .
51+
4252## Contributing
4353Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
4454
Original file line number Diff line number Diff line change 1616 long_description_content_type = "text/markdown" ,
1717 url = "https://github.com/Hoopher/commit-linter" ,
1818 packages = find_packages (),
19- classifiers = [
20- "Programming Language :: Python :: 3" ,
21- "License :: OSI Approved :: MIT License" ,
22- "Operating System :: OS Independent" ,
23- ],
2419 python_requires = '>=3.6' ,
2520 include_package_data = True ,
2621 package_data = {'' : ['hooks/*' ]},
2722 entry_points = {
2823 'console_scripts' : [
2924 'commit-linter = commit_linter.main:main' ],
30- }
25+ },
26+ classifiers = [
27+ "Programming Language :: Python :: 3" ,
28+ "License :: OSI Approved :: MIT License" ,
29+ "Operating System :: OS Independent" ,
30+ ]
3131)
You can’t perform that action at this time.
0 commit comments