Skip to main content

Commit Message Structure

  • If you are committing a feature, add feat: prefix then add description of the message.
Example: feat: added readme file
  • If you are committing a fix, add fix: prefix then add description of the message
Example: fix: fixed typo in readme file
  • If you are committing an improvement of an existing code, add impr: prefix then add description of the message
Example: impr: added validating to if an id is a mongodb id on top of checking if the field is empty
  • If you are committing a refactor of an existing code, add refact: prefix then add description of the message
Example: refact: reduced code for checking for null values on array
  • Tip: You can combine commit prefixes like:
Example: feat&fix: added readme file, fixed typo in readme file