Skip to content

Commit e0f768f

Browse files
committed
refactor: update comments for consistency in branch naming rules config
1 parent 9452749 commit e0f768f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

booster/validate-branch-name.config.cjs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

2-
// Branch naming rules config (single source of truth)
2+
/* Branch naming rules config (single source of truth) */
33
const config = {
4-
// Allowed branch types
4+
/** Allowed branch types */
55
types: ['feature', 'fix', 'chore', 'story', 'task', 'bug', 'sub-task'],
6-
// Optional ticket prefix and number (if not needed, set both to null)
7-
ticketIdPrefix: 'PRJ|ERM', // e.g. 'PRJ|ERM' (no parentheses)
8-
ticketNumberPattern: '[0-9]+', // e.g. '[0-9]+' or null
9-
// Branch name (after type and optional ticket)
6+
/** Optional ticket prefix and number (if not needed, set both to null) */
7+
ticketIdPrefix: 'PRJ|ERM', /** e.g. 'PRJ|ERM' (no parentheses) */
8+
ticketNumberPattern: '[0-9]+', /** e.g. '[0-9]+' or null */
9+
/** Branch name (after type and optional ticket) */
1010
namePattern: '[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*',
11-
// Branches to skip validation
11+
/** Branches to skip validation */
1212
skipped: ['wip', 'main', 'master', 'develop/test', 'develop/host1', 'develop/host2'],
13-
// Commit footer label to append with ticket (configurable)
13+
/** Commit footer label to append with ticket (configurable) */
1414
commitFooterLabel: 'Closes',
1515
};
1616

0 commit comments

Comments
 (0)