Skip to content

Commit 8a16207

Browse files
committed
Improved wording in PR quality check messages.
1 parent e0d64a5 commit 8a16207

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
ticket-XXXXX
66

77
#### Branch description
8-
<!-- Provide a concise overview of the issue or rationale behind the proposed changes. 5 word minimum. -->
8+
<!-- Provide a concise overview of the issue or rationale behind the proposed changes. Minimum five words. -->
99

1010
#### AI Assistance Disclosure (REQUIRED)
1111
<!-- Select exactly ONE of the following: -->

scripts/pr_quality/check_pr.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ def check_pr_title_has_ticket(pr_title, ticket_id):
330330

331331

332332
def check_branch_description(pr_body):
333-
"""The branch description should be at least 5 words long."""
333+
"""The branch description should be at least five words long."""
334334
description_match = re.search(
335335
r"#### Branch description[ \t]*\r?\n(.*?)(?=\r?\n####|\Z)",
336336
pr_body,
@@ -351,7 +351,7 @@ def check_branch_description(pr_body):
351351
def check_ai_disclosure(pr_body):
352352
"""Exactly one AI disclosure checkbox must be selected.
353353
354-
If the "AI tools were used" option is checked, at least 5 words of
354+
If the "AI tools were used" option is checked, at least five words of
355355
additional description must be present in that section.
356356
"""
357357
ai_match = re.search(
@@ -381,7 +381,7 @@ def check_ai_disclosure(pr_body):
381381
for line in section.splitlines()
382382
if line.strip() and not line.strip().startswith("- [")
383383
]
384-
# Ensure PR author includes at least 5 words about their AI use.
384+
# Ensure PR author includes at least five words about their AI use.
385385
if len(" ".join(extra_lines).split()) < MIN_WORDS:
386386
return Message(*MISSING_AI_DESCRIPTION)
387387

scripts/pr_quality/errors.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def as_details(self, level=LEVEL_ERROR):
7474
"AI Tool Usage Not Described",
7575
"You indicated that AI tools were used in preparing this PR, but you have not "
7676
"provided a description of which tools you used or how you used them. At least "
77-
"5 words of description are required.\n\n"
77+
"five words of description are required.\n\n"
7878
"**What to do:**\n\n"
7979
"Add a brief description below the checked AI disclosure checkbox in your PR "
8080
"description. For example:\n\n"
@@ -114,7 +114,7 @@ def as_details(self, level=LEVEL_ERROR):
114114
"Missing PR Description",
115115
"Your PR description must be substantive and meaningful.\n\n"
116116
"**What to do:**\n\n"
117-
"Write a description that contains at least 5 words and addresses:\n\n"
117+
"Write a description that contains at least five words and addresses:\n\n"
118118
"- What problem does this PR solve?\n"
119119
"- Why is this change necessary?\n"
120120
"- What approach did you take?\n\n"

scripts/pr_quality/tests/test_check_pr.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,7 @@ def test_make_pr_body_matches_template(self):
673673
ticket="ticket-XXXXX",
674674
description=(
675675
"<!-- Provide a concise overview of the issue or rationale behind"
676-
" the proposed changes. 5 word minimum. -->"
676+
" the proposed changes. Minimum five words. -->"
677677
),
678678
no_ai_checked=False,
679679
ai_used_checked=False,

0 commit comments

Comments
 (0)