Skip to content

Commit

Permalink
chore: Clarify usage of example regexes
Browse files Browse the repository at this point in the history
  • Loading branch information
benhodgson87 authored Sep 16, 2024
1 parent 14ff798 commit 2ee919d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ 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

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
Expand Down

0 comments on commit 2ee919d

Please sign in to comment.