docs: Add conventional commit note to contributing.md (#974)
Copied from the current version in template-oss. It's not ideal in that if we change it in template-oss this one won't change, but it's better than NOT having it.
Gar committed
Feb 13, 2024 at 14:47 UTC
6aebf62c182fd008a6137c4e2fcb7d8651543763
1 file changed
+11
CONTRIBUTING.md
+11
@@ -47,6 +47,17 @@ GATSBY_CONTENT_IGNORE=cli/v6,cli/v7,cli/v8,cli/v9 npm run develop
47
48
## Updating content
49
50
+### Commits
51
+
52
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
53
+
54
+When opening a pull request please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:
55
+
56
+- `feat`: For when introducing a new feature.
57
+- `fix`: For bug fixes.
58
+- `docs`: For documentation updates. This specifically means the documentation in and this repo, NOT the contents of the documentation site itself.
59
+- `chore`: For changes that do not affect the published site. Often these are changes to tests. The result will be _no_ change to the website when it is next published.
60
+
61
### Documentation content
62
63
The documentation content lives in the `content` directory, and is Markdown. (Actually, [MDX](https://mdxjs.com/), a sort of reactive Markdown.)