privacyguides.org/docs/meta/commit-messages.md

---
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:

## Update to existing text

This example could be used for an item already on the site, but includes a minor update to the description.

```text
update: Add mention of security audit (#0000)
```

## Addition or removal of recommendations/pages

This example is for the addition or removal of an item. You may elaborate why it was removed in the commit paragraph below. Note the extra `!` to draw attention to a major change.

```text
update!: Remove foobar (#0000)

Foobar was removed due to it having numerious security issues and being unmaintained.
```

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:

```text
feat: Add blah blah (#0000)

This change adds the forum topics to the main page
```

## Development-related types

These commit types are typically used for changes that won't be visible to the general audience.

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
docs: Update Git commit message guidelines (#0000)
```

We use `build:` for commits related to our build process, mainly dependency updates.

```text
build: Bump modules/mkdocs-material from 463e535 to 621a5b8
```

We use `ci:` for commits related to GitHub Actions, DevContainers, or other automated build platforms.

```text
ci: Update Netlify config (#0000)
```

We use `refactor:` for changes which neither fix a bug nor add a feature.

```text
refactor: Move docs/assets to theme/assets
```