Skip to content

Commit 5b7388e

Browse files
committed
docs: update line length and review guidelines for PR_DESCRIPTION.md
- Increased the line length limit from 100 to 120 characters in `AGENTS.md` and `AGENT_GUIDE.md` for better readability. - Added exclusions for `PR_DESCRIPTION.md` in `review-implement.md`, `review-validate.md`, and `review.md` to clarify that this file should not be reviewed or flagged for issues. These updates aim to enhance documentation clarity and improve the review process by clearly defining the scope of review files.
1 parent bb87361 commit 5b7388e

File tree

5 files changed

+6
-2
lines changed

5 files changed

+6
-2
lines changed

.cursor/commands/review-implement.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ After a review has been validated via `/review-validate`, implement the remainin
2626
- Read the review file and extract: Review Summary, Metrics, and Findings grouped by severity.
2727
- **Include**: Critical and High severity findings with `file:line` references and explicit "Change:" recommendations.
2828
- **Exclude**: Findings marked as "Out of scope", "Deferred", or requiring external clarification ("NEEDS CLARIFICATION").
29+
- **Exclude**: Findings related to `PR_DESCRIPTION.md` (this file is for PR authoring and should not be modified).
2930
- **User Override**: If `$ARGUMENTS` contains specific finding IDs (e.g., `--findings Spec-1`), implement only those.
3031

3132
3. **Prioritize & Implement**

.cursor/commands/review-validate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ After a review report exists in `reviews/`, re-check the current state, validate
2929
- Compare the current repo state to the review file contents.
3030
- Remove or downgrade findings that no longer apply.
3131
- Add new findings based on the current diff/state, using deterministic IDs that continue existing sequences.
32+
- **Ignore `PR_DESCRIPTION.md`**: Do not flag issues in `PR_DESCRIPTION.md`; it is for PR authoring purposes only.
3233
5. **Update Review Report**
3334
- Keep the same template and formatting as `.cursor/commands/review.md`.
3435
- Update **Executive Summary**, **Findings**, **Strengths**, **Testing Results**, and **Metrics Summary**.

.cursor/commands/review.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Provide clear, high-impact review findings that keep the implementation simple,
4040

4141
4. **File Analysis**
4242
- List changed non-test files; note responsibility and trim opportunities.
43+
- **Ignore `PR_DESCRIPTION.md`**: This file is for PR authoring and should not be reviewed. Do not flag issues in this file.
4344
- Apply language-specific review rules (Python 3.11+, FastAPI).
4445

4546
## Analysis Directives (CRITICAL FOCUS)
@@ -226,5 +227,6 @@ Use this format only in the optional appendix if needed for large change sets.
226227
- **Use Evidence**: Base findings on actual code analysis.
227228
- **Avoid Nitpicking**: Focus on substantive issues.
228229
- **Prefer minimal deltas**: Smallest viable change relative to main.
230+
- **Ignore PR_DESCRIPTION.md**: Do not review or flag issues in `PR_DESCRIPTION.md`; it is for PR authoring purposes only.
229231

230232
Context: $ARGUMENTS

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Prefer `uv run ...` when invoking project tooling directly (e.g., `uv run pytest
3333

3434
- Type hints required for all functions (mypy strict-ish; see `[tool.mypy]`)
3535
- Docstrings: Google style (ruff pydocstyle)
36-
- Line length: 100 (ruff)
36+
- Line length: 120 (ruff)
3737
- Quotes: double quotes (ruff formatter)
3838
- Imports: standard → third-party → local; use `from __future__ import annotations`
3939
- **Mutable defaults**: Use `default_factory` for lists/dicts (e.g., `Field(default_factory=lambda: [])`)

docs/02-implementation/AGENT_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ personal-todo/
7878

7979
### Python Style
8080

81-
- **Line length**: 100 characters (configured in `ruff`)
81+
- **Line length**: 120 characters (configured in `ruff`)
8282
- **Type hints**: Required for all functions (mypy strict mode)
8383
- **Docstrings**: Google style (configured in `ruff`)
8484
- **Imports**: Use `from __future__ import annotations` for forward references

0 commit comments

Comments
 (0)