diff --git a/docs/meta/commit-messages.md b/docs/meta/commit-messages.md index 462c04b1..0b2f484d 100644 --- a/docs/meta/commit-messages.md +++ b/docs/meta/commit-messages.md @@ -24,14 +24,6 @@ Foobar was removed due to it having numerious security issues and being unmainta You can actually add a `!` to *any* of the types on this page to denote particularly large changes, but this is generally where it will be most appropriate. -## Commit message with correction - -We use `fix` for simple things like spelling mistakes or site related bugs. These things will usually have the `correction` or `bug` label on GitHub. - -```text -fix: Correct spelling on XYZ page (#0000) -``` - ## Feature/enhancement For new features or enhancements to the site, e.g. things that have the `enhancements` label on GitHub, it may be appropriate to signify these with: @@ -42,10 +34,24 @@ feat: Add blah blah (#0000) This change adds the forum topics to the main page ``` +## Minor changes + +Small changes that **don't affect the meaning** of the article, e.g. correcting a typo, fixing grammar, changing formatting/whitespace, CSS updates, etc. + +```text +style: Typo correction in VPN overview +``` + ## Development-related types These commit types are typically used for changes that won't be visible to the general audience. +We use `fix:` for changes that fix site related bugs. These things will usually have the `bug` label on GitHub. + +```text +fix: Remove broken Invidious embeds (#0000) +``` + We use `docs:` to denote changes to the developer documentation for this website, including (but not limited to) for example the README file, or most pages in `/docs/about` or `/docs/meta`: ```text @@ -64,7 +70,7 @@ We use `ci:` for commits related to GitHub Actions, DevContainers, or other auto ci: Update Netlify config (#0000) ``` -We use `refactor:` for changes which neither fix a bug nor add a feature. +We use `refactor:` for changes which neither fix a bug nor add a feature, e.g. rearranging files, navigation order, etc. ```text refactor: Move docs/assets to theme/assets