Skip to content

Commit Messages

Methusshan Elankumaran edited this page Jun 16, 2024 · 8 revisions

Structure of commit messages:

(type) (subject): (description)

Type

  • feat: Commits, that adds or remove a new feature
  • fix: Commits, that fixes a bug
  • refactor: Commits, that rewrite/restructure your code, however does not change any API behaviour
  • perf: Commits are special refactor commits, that improve performance
  • style: Commits, that do not affect the meaning (white-space, formatting, missing semi-colons, etc)
  • test: Commits, that add missing tests or correcting existing tests
  • docs: Commits, that affect documentation only
  • build: Commits, that affect build components like build tool, ci pipeline, dependencies, project version, ...
  • ops: Commits, that affect operational components like infrastructure, deployment, backup, recovery, ...
  • chore: Miscellaneous commits e.g. modifying .gitignore

Subject

  • File or part of software, which is changed/updated

Description

  • Description of the change which is commited
Clone this wiki locally