Conventional Commits

Repository to show git commit pattern based on 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

<type>[optional scope]: <description>

[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

$ 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]