https://github.com/shikaan/cleancommit
Enforce commit standards. No dependencies
https://github.com/shikaan/cleancommit
bash commitizen declarative zero-dependency
Last synced: about 1 month ago
JSON representation
Enforce commit standards. No dependencies
- Host: GitHub
- URL: https://github.com/shikaan/cleancommit
- Owner: shikaan
- Created: 2019-02-24T20:18:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-25T12:03:44.000Z (about 7 years ago)
- Last Synced: 2025-04-07T03:31:48.973Z (about 1 year ago)
- Topics: bash, commitizen, declarative, zero-dependency
- Language: Shell
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
cleancommit
---
## Run tests
```
watch ./test.bash
```
## Conventions
#### Name of methods
Since we cannot have type hint for these methods, the convention is that every _noun_ in the name after _by_ is an argument in the same order are they appear.
##### Example:
`check_message_by_message_and_type_and_name` will have as argument `MESSAGE`, `TYPE`, `NAME`
#### Private methods
Methods with leading double underscore should never be used outside the file where they are defined
##### Example:
`__i_am_a_private_method`
#### Case
Local variables are lowercase, global variable are uppercase. Global variables should
_NEVER_ be used