Skip to content

Commit 133e686

Browse files
eschuthoclaude
andauthored
docs(llms): add PR template guidelines to LLMS.md (#35148)
Co-authored-by: Claude <[email protected]>
1 parent 7d0a472 commit 133e686

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

LLMS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,19 @@ curl -f http://localhost:8088/health || echo "❌ Setup required - see https://s
136136
- **Use negation operator**: `~Model.field` instead of `== False` to avoid ruff E712 errors
137137
- **Example**: `~Model.is_active` instead of `Model.is_active == False`
138138

139+
## Pull Request Guidelines
140+
141+
**When creating pull requests:**
142+
143+
1. **Read the current PR template**: Always check `.github/PULL_REQUEST_TEMPLATE.md` for the latest format
144+
2. **Use the template sections**: Include all sections from the template (SUMMARY, BEFORE/AFTER, TESTING INSTRUCTIONS, ADDITIONAL INFORMATION)
145+
3. **Follow PR title conventions**: Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
146+
- Format: `type(scope): description`
147+
- Example: `fix(dashboard): load charts correctly`
148+
- Types: `fix`, `feat`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`
149+
150+
**Important**: Always reference the actual template file at `.github/PULL_REQUEST_TEMPLATE.md` instead of using cached content, as the template may be updated over time.
151+
139152
## Pre-commit Validation
140153

141154
**Use pre-commit hooks for quality validation:**

0 commit comments

Comments
 (0)