From 2ee919d87a202f69113c8cc348010b2eb5a783fa Mon Sep 17 00:00:00 2001 From: Ben Hodgson <189707+benhodgson87@users.noreply.github.com> Date: Mon, 16 Sep 2024 22:12:07 +0100 Subject: [PATCH] chore: Clarify usage of example regexes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe358b2..5703d10 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ By default, scope linting will only occur when a PR title contains a scope. If y Lint for any Jira ticket format, eg `FOO-123`, `BAR-234`, `BAZ-345` ```ts -^[A-Z]+-[0-9]+$ +scopeRegex: '^[A-Z]+-[0-9]+$' ``` ##### Specific Jira project tickets @@ -105,7 +105,7 @@ Lint for any Jira ticket format, eg `FOO-123`, `BAR-234`, `BAZ-345` Only allow tickets from three specific projects; `SPECIFIC-123`, `JIRA-234`, `PROJECT-345`. `FOO-456` would be rejected. ```ts -^((SPECIFIC|JIRA|PROJECT)-[0-9]+)$ +scopeRegex: '^((SPECIFIC|JIRA|PROJECT)-[0-9]+)$' ``` ### Skipping scope linting