From 749ff2ed1ebf74c3097c560e8a4a85b4aff04221 Mon Sep 17 00:00:00 2001 From: PhracturedBlue Date: Tue, 19 Sep 2023 08:19:19 -0700 Subject: [PATCH] docs(site): Add description of title-checker when submitting a PR (#3331) --- site/content/docs/Contribution guidelines/_index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/site/content/docs/Contribution guidelines/_index.md b/site/content/docs/Contribution guidelines/_index.md index 4ecf3c976..fcfb37825 100644 --- a/site/content/docs/Contribution guidelines/_index.md +++ b/site/content/docs/Contribution guidelines/_index.md @@ -29,3 +29,9 @@ toc_hide: true - `make ci-tests` - `make lint-all` (if developing cross-platform code) - `make goreleaser` +* When creating a PR, the title should match the pattern ``(``): `` where: + - `` is one of: `feat`, `fix`, `breaking`, `build`, `chore`, `docs`, `style`, `refactor`, `test`. + - `` is one of: `kopiaui`, `cli`, `ui`, `repository`, `snapshots`, `server`, `providers`, `deps`, `deps-dev`, `site`, `ci`, `infra`, `general`. + - `` is a clear description of a PR. + - Follow the pattern precisely, as the title-checker cares about capitalization parentheses, and spaces. + - For example: `feat(cli): Add new policy rule --new-feature-x to enable using feature x`.