https://github.com/raphaelbh/conventional-commits
The Conventional Commits specification is a lightweight convention on top of commit messages.
https://github.com/raphaelbh/conventional-commits
commit commit-conventions commit-message commit-message-template conventional-commits git template
Last synced: 2 months ago
JSON representation
The Conventional Commits specification is a lightweight convention on top of commit messages.
- Host: GitHub
- URL: https://github.com/raphaelbh/conventional-commits
- Owner: raphaelbh
- Created: 2022-02-11T17:50:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-24T14:00:18.000Z (about 3 years ago)
- Last Synced: 2025-01-25T20:11:30.427Z (4 months ago)
- Topics: commit, commit-conventions, commit-message, commit-message-template, conventional-commits, git, template
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Conventional Commits
[](#)
Repository to show git commit pattern based on [conventionalcommits.org](https://www.conventionalcommits.org/)
> The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
## Template
```
[optional scope]:
[optional body]
[optional footer]
```
## Types
- **feat**: new feature
- **fix**: bug fix
- **refactor**: code refactor
- **style**: formatting changes (markup, white-space, ...)
- **build**: build related changes
- **ci**: ci changes
- **test**: add/fix tests
- **chore**: no production code change
- **docs**: change documentation
## Usage
```bash
$ git commit -m "fix: prevent racing of requests" -m "Introduce a request id and a reference to latest request."
```
## Reference
- https://www.conventionalcommits.org/
## Feedback
If you have any feedback, please contact me at [email protected]
[](https://github.com/raphaelbh)
[](https://www.linkedin.com/in/raphaelbh/)