- name
- pull-requests
- description
- Create and review pull requests following project standards including title format, description template, and review checklist. Use when creating PRs, writing PR descriptions, or reviewing pull requests.
# Pull Request Guidelines
## Creating a PR
### PR Title
Include issue number at the start:
```
RI-123 Add user profile editing
#456 Fix memory leak in connection pool
```
### PR Description Template
```markdown
# What
Describe what was changed.
# Testing
Describe how to test the changes.
---
Refs #RI-123
```
**PR Description Guidelines:**
- **Keep it concise** - Avoid verbose descriptions
- **Focus on high-level changes** - Don't list every code change in the #What section
- **Brief and to the point** - The diff shows the details; describe the "why" and "what" at a high level
- **Technical decisions** - Only mention significant architectural or design decisions if relevant
- **Link, don't auto-close** - Use `Refs #RI-123` / `Addresses #RI-123`, not `Closes`/`Fixes`/`Resolves` - those keywords auto-close the issue when the PR merges, and tickets should be closed manually, not by the merge
## Review Process
### As PR Author
- **Respond to all comments** - Address every piece of feedback
- **Don't take feedback personally** - Reviews improve code quality
- **Update code based on feedback** - Make requested changes
- **Mark conversations as resolved** - After addressing feedback
- **Keep PR up to date** - Rebase on main regularly
### As PR Reviewer
- **Be constructive and respectful** - Focus on improvement
- **Focus on logic, not style** - Linter handles formatting
- **Check for**:
- Logic errors and edge cases
- Performance issues
- Security concerns
- Test coverage
- Missing documentation
- Architectural concerns
### Review Checklist
- [ ] Code follows project patterns
- [ ] Tests are comprehensive
- [ ] No console.log or debug code
- [ ] TypeScript types are proper
- [ ] Error handling is adequate
- [ ] Documentation is updated
- [ ] No security vulnerabilities
- [ ] Performance is acceptable
View on GitHub