From 6493cc20761b6410dad27cc1c060a434cfb0264e Mon Sep 17 00:00:00 2001
From: Daniel Gray <dngray@privacyguides.org>
Date: Mon, 3 Jun 2024 04:07:02 +0000
Subject: [PATCH] update: Commit recommendations meta page (#2604)

Signed-off-by: redoomed1 <161974310+redoomed1@users.noreply.github.com>
Signed-off-by: Jonah Aragon <jonah@privacyguides.org>
---
 docs/meta/commit-messages.md | 49 ++++++++++++++++++++++++++++++++++++
 mkdocs.yml                   |  1 +
 2 files changed, 50 insertions(+)
 create mode 100644 docs/meta/commit-messages.md

diff --git a/docs/meta/commit-messages.md b/docs/meta/commit-messages.md
new file mode 100644
index 00000000..51a55aaa
--- /dev/null
+++ b/docs/meta/commit-messages.md
@@ -0,0 +1,49 @@
+---
+title: Commit Messages
+---
+
+For our commit messages we follow the style provided by [Conventional Commits](https://conventionalcommits.org). Not all of those suggestions are appropriate for Privacy Guides, so the main ones we use are:
+
+## 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)
+```
+
+## Update to site
+
+This example is for a removal of an item (but could also be used for an addition); you may elaborate why it was removed in the commit paragraph below. It can also be used for the addition of any new pages.
+
+```text
+update: Remove foobar (#0000)
+
+Foobar was removed due to it having numerious security issues and being unmaintained.
+```
+
+## Update to specific item
+
+This example could be used for an item already on the site, but includes a minor update to the description.
+
+```text
+foobar: Add mention of security audit (#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:
+
+```text
+feat: Add blah blah (#0000)
+
+This change adds the forum topics to the main page
+```
+
+## Module update
+
+Dependency updates follow the normal recommendations of beginning with:
+
+```text
+chore: Bump modules/mkdocs-material from 463e535 to 621a5b8
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index c0c0356f..8bbd8c6e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -447,6 +447,7 @@ nav:
           - !ENV [NAV_TECHNICAL_GUIDES, "Technical Guides"]:
               - "meta/uploading-images.md"
               - "meta/git-recommendations.md"
+              - "meta/commit-messages.md"
   - !ENV [NAV_DONATE, "Donate"]: "about/donate/"
   - !ENV [NAV_CHANGELOG, "Changelog"]:
       "https://github.com/privacyguides/privacyguides.org/releases"