Skip to content

Commit fc162d1

Browse files
committed
docs: add PR conventions guide
1 parent 60fa449 commit fc162d1

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

.cursor/rules/pr-conventions.mdc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
description: Conventions for pull request titles and body content
3+
alwaysApply: true
4+
---
5+
6+
# Pull Request Conventions
7+
8+
## PR Title
9+
10+
Use semantic/conventional commit prefixes in PR titles:
11+
12+
- `fix:` for bug fixes
13+
- `feat:` for new features
14+
- `chore:` for maintenance tasks (deps, CI, tooling)
15+
- `refactor:` for code restructuring without behavior changes
16+
- `docs:` for documentation-only changes
17+
- `test:` for test-only changes
18+
19+
Example: `fix: resolve notification grouping on Android 14`
20+
21+
## PR Body
22+
23+
Follow the repo's PR template at `.github/pull_request_template.md`. Every PR body must include:
24+
25+
1. **One Line Summary** (required)
26+
2. **Motivation** (required) explaining why the change is being made
27+
3. **Scope** (recommended) describing what is and isn't affected
28+
4. **Testing** section with manual and/or unit testing details
29+
5. **Affected code checklist** with relevant items checked
30+
6. **Checklist** sections confirmed
31+
32+
Remove the instructional header block (between `<!-- START -->` and `<!-- END -->`) before submitting.

0 commit comments

Comments
 (0)