From e5f289aaf9a305c4049c96e00b3d35a282df3c35 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 18 May 2026 19:19:44 +0000 Subject: [PATCH] Rules: Uppercase RFC 2119 keywords in GitHub Issues sections #5584 --- .claude/rules/commit-and-docs-style.md | 2 +- AGENTS.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.claude/rules/commit-and-docs-style.md b/.claude/rules/commit-and-docs-style.md index cf65fa580..5d17e8db1 100644 --- a/.claude/rules/commit-and-docs-style.md +++ b/.claude/rules/commit-and-docs-style.md @@ -23,7 +23,7 @@ Follow the User Story with a clear summary of the expected behavior, rationale, Descriptions MUST conclude with a checklist of **Acceptance Criteria**: - Use GitHub checklist formatting: `- [ ]` - Criteria MUST be clear, testable, and unambiguous. -- Each item MUST use one of the following priority keywords: +- Each item MUST use one of the following requirement-level keywords: - `MUST` — required for the issue to be considered complete - `SHOULD` — strongly recommended but not strictly required - `MAY` — optional enhancement diff --git a/AGENTS.md b/AGENTS.md index 06c525945..74fe0eef2 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -49,12 +49,12 @@ Optional nested repositories such as `plus/`, `pro/`, `portal/`, and `specs/` ma ### GitHub Issues -- Titles must be concise, imperative, and start with one capitalized prefix plus `: `, for example `Search: Add filter for RAW image formats`. -- Descriptions must begin with a one-sentence bold user story: `**As a , I want , so that .**` +- Titles MUST be concise, imperative, and start with one capitalized prefix plus `: `, for example `Search: Add filter for RAW image formats`. +- Descriptions MUST begin with a one-sentence bold user story: `**As a , I want , so that .**` - Use level-3 Markdown headings for sections within issue descriptions, for example `### Acceptance Criteria`. - Follow with behavior, rationale, technical considerations, and constraints. - End with `- [ ]` checklist items for the acceptance criteria, each using `MUST`, `SHOULD`, or `MAY`. -- Agents may create, edit, close, reopen, relabel, or otherwise modify GitHub issues only when explicitly requested by the user. +- Agents MUST create, edit, close, reopen, relabel, or otherwise modify GitHub issues only when explicitly requested by the user. ### Specifications & Documentation