Menu
Create a new PR for the current branch or update an existing one. Follows team PR best practices for titles, descriptions, and checklists.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Analyze a project or workspace to identify repeated patterns and propose abstractions for improved code reuse and maintainability.
Review codebase changes and create well-structured conventional commits with Shortcut ticket links. Use when asked to commit, save changes, or prepare code for review.
Run linting checks and fix all issues idiomatically. Never disables rules or suppresses errors.
Migrate React components from Snowflake SQL queries to NQL using the useNqlQuery hook. Handles query design, case sensitivity, and React dependency optimization.
Analyze and improve a React/TypeScript code file following component composition, hooks, performance, and file organization best practices.
Create a new Shortcut ticket or rewrite an existing one with comprehensive specs including problem statement, requirements, SOC-2 compliance, and implementation plan.
| name | pr |
| description | Create a new PR for the current branch or update an existing one. Follows team PR best practices for titles, descriptions, and checklists. |
Create a PR for the current branch if one doesn't exist. If one does exist, update it. Use the guide below for best practices.
This guide outlines best practices for writing pull request (PR) titles and descriptions. Following these guidelines ensures your PRs are clear, reviewable, and maintain a consistent standard across our codebase.
Use a consistent format that clearly communicates the change type and scope:
[Type] Brief description of change
[Feature] - New functionality or capability[Fix] - Bug fixes or corrections[Refactor] - Code restructuring without changing functionality[Perf] - Performance improvements[Docs] - Documentation updates[Test] - Test additions or modifications[Chore] - Maintenance tasks, dependency updates[Style] - Code formatting, naming conventionsBe concise but descriptive (50-72 characters ideal)
[Feature] Add user authentication via OAuth2[Feature] Added authUse imperative mood (as if giving a command)
[Fix] Resolve memory leak in data processor[Fix] Fixed memory leak in data processorInclude ticket/issue reference when applicable
[Feature] Add payment gateway integration (PROJ-1234)[Fix] Prevent duplicate submissions in checkout flow #5678Be specific about what changed
[Refactor] Extract validation logic into separate service[Refactor] Code cleanupUse this template for all PRs:
## Summary
Brief overview of what this PR accomplishes and why it's needed.
## Changes Made
- Bullet point list of specific changes
- Group related changes together
- Be specific about what was modified
## Type of Change
- [ ] Bug fix (non-breaking change fixing an issue)
- [ ] New feature (non-breaking change adding functionality)
- [ ] Breaking change (fix or feature causing existing functionality to change)
- [ ] Refactoring (no functional changes)
- [ ] Documentation update
- [ ] Performance improvement
## Testing
Describe the testing performed:
- Unit tests added/modified
- Integration tests
- Manual testing steps
- Test coverage impact
## Screenshots/Recordings (if applicable)
Include visual evidence for UI changes
## Related Issues
Closes #(issue number)
Related to #(issue number)
## Deployment Notes
Any special deployment considerations, migrations, or configuration changes
## Checklist
- [ ] Code follows team style guidelines
- [ ] Self-review completed
- [ ] Comments added for complex logic
- [ ] Documentation updated
- [ ] Tests added/updated
- [ ] All tests passing
- [ ] No console.log or debug code left
- [ ] Breaking changes documented
- [ ] If this PR completes a Shortcut Ticket, move the Ticket into Review (in Workflow: Default)
The summary should answer three questions:
Example:
## Summary
This PR implements rate limiting for our public API endpoints to prevent abuse and ensure service stability. Previously, there were no limits on API calls, which led to service degradation during high-traffic periods. This solution uses Redis to track and limit requests per IP address to 100 requests per minute.
Be specific and organize changes logically:
## Changes Made
Authentication Changes:
- Added JWT token validation middleware
- Implemented refresh token rotation
- Added token expiration handling
Database Changes:
- Created user_sessions table
- Added indexes for performance optimization
- Updated user table with last_login timestamp
API Changes:
- New endpoint: POST /api/auth/refresh
- Modified: GET /api/user/profile (now requires authentication)
- Deprecated: GET /api/user/public-profile
Provide enough detail for reviewers to verify your testing:
## Testing
Unit Tests:
- Added 15 new tests for AuthService
- Modified existing UserController tests for new auth flow
- Test coverage increased from 78% to 85%
Manual Testing:
1. Login with valid credentials - Success
2. Login with invalid credentials - Returns 401
3. Access protected endpoint with valid token - Success
4. Access protected endpoint with expired token - Returns 401, prompts refresh
5. Refresh token flow - Successfully generates new token pair
Load Testing:
- Tested with 1000 concurrent users
- Average response time: 45ms
- No memory leaks detected
Vague descriptions
Missing context
Combining unrelated changes
Insufficient testing information
Forgetting deployment considerations
Keep PRs small and focused
Provide context for reviewers
Use draft PRs for work in progress
Respond to feedback constructively
## Summary
Implements real-time notifications for order status updates. Customers previously had to refresh the page to see order updates, leading to poor user experience and increased server load. This PR adds WebSocket support to push updates instantly when order status changes.
## Changes Made
Backend:
- Added WebSocket server using Socket.io
- Created NotificationService for managing connections
- Integrated with existing OrderService for status updates
Frontend:
- Added WebSocket client connection handling
- Created notification toast component
- Updated order tracking page with real-time updates
Infrastructure:
- Added Redis for managing WebSocket sessions across servers
- Updated nginx configuration for WebSocket support
[... continues with full template ...]
## Summary
Fixes critical bug where users could place duplicate orders by rapidly clicking the submit button. This resulted in multiple charges and inventory discrepancies. The fix implements request debouncing and adds server-side duplicate detection.
## Changes Made
- Added 2-second debounce to order submit button
- Implemented idempotency key for order creation endpoint
- Added database constraint to prevent duplicate orders within 5-minute window
- Updated error handling to show user-friendly messages
[... continues with full template ...]
Remember: A well-written PR description saves review time, prevents misunderstandings, and serves as valuable documentation for future reference. Take the time to write clear, comprehensive PR descriptions—your teammates and future self will thank you!