Mirrors/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2026-07-17 16:49:04 +00:00
Code Issues Projects Releases Wiki Activity

Rules: Uppercase RFC 2119 keywords in GitHub Issues sections #5584

Browse source
This commit is contained in:
Michael Mayer 2026-05-18 19:19:44 +00:00
parent b92897949c
commit e5f289aaf9
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.claude/rules/commit-and-docs-style.md
View file

@ -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

6
AGENTS.md
View file

@ -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 <role>, I want <goal>, so that <outcome>.**`
- 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 <role>, I want <goal>, so that <outcome>.**`
- 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