Skip to content

Instantly share code, notes, and snippets.

@johnnymatthews
johnnymatthews / semantic-commit-messages-for-documentations.md
Last active September 7, 2024 15:33 — forked from joshbuchea/semantic-commit-messages.md
Semantic commit messages for documentation.

I'm sure we've all seen Git repos with a shocking amount of branches. Without a decent naming convention, things can get messy real quick. The idea here is that adding the tags below to the start of your branch makes it easier for folks to quickly figure out what your trying to do.

These are the available types:

Type Description Example
feat Adds a new section or page. New paragraphs to existing documentation are not a feature. feat/desktop-install
add Adds a new paragraph, sentence, or image to existing documentation. add/desktop-install-screenshots
remove Removes existing paragraphs, sentences, or images from existing documentation remove/browser-disclaimer
fix Fixes an existing typo, spelling, grammar, or formatting mistake. feat/desktop-broken-repo-link