Skip to content

Instantly share code, notes, and snippets.

@rdeak

rdeak/commit-message.md

Created April 22, 2021 07:47
Show Gist options
  • Save rdeak/fa7d9f76429e4e54029c3da0d226e3a6 to your computer and use it in GitHub Desktop.
Save rdeak/fa7d9f76429e4e54029c3da0d226e3a6 to your computer and use it in GitHub Desktop.
Download ZIP
Rules for structuring commit messages
Raw
commit-message.md

Rules for comit message

Format

<type> [scope]: "Message"

Type

Type must be one of the following mentioned below :

: Build related changes (eg: npm related/ adding external dependencies) : A code change that external user won't see (eg: change to .gitignore) : Documentation related changes : Introduction of a new feature : Resolve an issue directly linked to development (bugfixes) : Resolve an issue directly linked to production (patches) : Add/Update test cases : Add code that improves performance : Update for code for maintainability (clean code)

Examples

feat(home, components): Add login button
feat(home, components): Add login modal
fix(home, components): Resolve issue with modal collapses
chore(home): Move icons folder
feat(newsletter): Add Newsletter component
feat(navbar): Add navbar container
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment