An open API service indexing awesome lists of open source software.

https://github.com/thiagodp/commitment

✨ Simple rules for your commit messages ✨
https://github.com/thiagodp/commitment

best-practice commit commitment content format guide mensagem message padrao regra rule

Last synced: 8 months ago
JSON representation

✨ Simple rules for your commit messages ✨

Awesome Lists containing this project

README

          

# commitment
> ✨Simple rules for your commit messages ✨

## Rules

- **[In English](rules-en.md)**
- **[Em Português](rules-pt.md)**

## Contribute

Do you have a suggestion? 🆒 Are you interested in translating the rules? Please [let us know](https://github.com/thiagodp/commitment/issues/new) ! 👀 Merge requests are also *welcome* ♥.

## See also

- [conventional commits](http://conventionalcommits.org/) specification
- [commit-lint](https://github.com/conventional-changelog/commitlint) to *lint* your commit messages
- [commitizen](https://github.com/commitizen/cz-cli) to help you with commit messages
- [validate-commit](https://github.com/willsoto/validate-commit) to validate according to some presets
- [husky](https://github.com/typicode/husky) to use git hooks such as `pre-commit` and `pre-push`
- Many rules presented here are discussed elsewhere, *e.g.*, [1](https://chris.beams.io/posts/git-commit/), [2](https://www.freshconsulting.com/atomic-commits/), [3](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project), [4](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages).

## License

MIT © [Thiago Delgado Pinto](https://github.com/thiagodp)