From 2636fd404b9fb33f01d65f3b8f64e007a4165605 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 18 May 2026 17:29:18 +0200 Subject: [PATCH] Rules: Update GitHub issue description writing rules Signed-off-by: Michael Mayer --- .claude/rules/commit-and-docs-style.md | 2 +- AGENTS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.claude/rules/commit-and-docs-style.md b/.claude/rules/commit-and-docs-style.md index d811527c5..7cd3f4e49 100644 --- a/.claude/rules/commit-and-docs-style.md +++ b/.claude/rules/commit-and-docs-style.md @@ -17,7 +17,7 @@ Do not add `Co-Authored-By: Claude …` trailers (or any other AI-authorship tra Issue titles MUST be concise, use the imperative mood, and start with a single capitalized prefix followed by a colon and a space, e.g. `Search: Add filter for RAW image formats`. Issue descriptions MUST begin with a one-sentence **User Story** in the format: `**As a , I want , so that .**` -Use level-4 Markdown headings for sections within issue descriptions, for example `#### Acceptance Criteria`. +Use level-3 Markdown headings for sections within issue descriptions, for example `### Acceptance Criteria`. Follow the User Story with a clear summary of the expected behavior, rationale, technical considerations, and constraints. Descriptions MUST conclude with a checklist of **Acceptance Criteria**: diff --git a/AGENTS.md b/AGENTS.md index 50409b067..1aec598d8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -51,7 +51,7 @@ Optional nested repositories such as `plus/`, `pro/`, `portal/`, and `specs/` ma - 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-4 Markdown headings for sections within issue descriptions, for example `#### Acceptance Criteria`. +- 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.