From b2f274f9909674b81dd39d522952e8bcf57ef092 Mon Sep 17 00:00:00 2001 From: Ben Hodgson Date: Sun, 16 Jun 2024 15:05:59 +0100 Subject: [PATCH] chore: Fix docs --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8b06a97..145f314 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ jobs: | --------------------- | -------- | ------------------------- | ------------------------------------------------------------------------------------------------------- | | `commitlintRulesPath` | No | `'./commitlint.rules.js'` | A relative path from the repo root to a file containing custom Commitlint rules to override the default | | `scopeRegex` | No | `'[A-Z]+-[0-9]+'` | A JS regex (without slashes or flags) used to lint the PR scope | -| `enforcedScopeType`s | No | `'feat\|fix'` | A list of PR types where the scope is always required and linted | +| `enforcedScopeTypes` | No | `'feat\|fix'` | A list of PR types where the scope is always required and linted | ## Usage @@ -117,12 +117,12 @@ enforcedScopeTypes: 'feat|fix' With the above config, using the example regex string in the previous section; -- > ✅ feat(BAR-1234): This PR title is ok -- > ✅ fix(FOO-2345): This PR title is also ok -- > ✅ chore: This PR title is ok too, as chore is not an enforced type -- > 🚫 feat: This is a feature PR so requires a ticket in the scope -- > 🚫 fix(FOO-): The regex also expects the ticket number -- > 🚫 feat(ci): This scope doesn't match the permitted regex +> ✅ feat(BAR-1234): This PR title is ok +> ✅ fix(FOO-2345): This PR title is also ok +> ✅ chore: This PR title is ok too, as chore is not an enforced type +> 🚫 feat: This is a feature PR so requires a ticket in the scope +> 🚫 fix(FOO-): The regex also expects the ticket number +> 🚫 feat(ci): This scope doesn't match the permitted regex ### Skipping for bot PRs