Skip to content

Commit

Permalink
docs: Use style commit type for minor grammar/typo fixes (#2687)
Browse files Browse the repository at this point in the history
Signed-off-by: Freddy <[email protected]>
Signed-off-by: Daniel Gray <[email protected]>
Signed-off-by: Mare Polaris <[email protected]>
  • Loading branch information
jonaharagon authored and dngray committed Aug 2, 2024
1 parent 11f3f8a commit 9d13faf
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions docs/meta/commit-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 9d13faf

Please sign in to comment.