Appearance
Pull Request Guidelines
Creating Pull Requests
Branch Naming
Follow the pattern from Shortcut:
type/sc-[ticket-id]-descriptionExamples:
feature/sc-123-add-event-creationbugfix/sc-456-fix-login-error
PR Template
When creating a PR, include:
- What - Brief description of changes
- Why - Context from Shortcut ticket
- How to Test - Steps to verify the changes work
Commit Messages
Start all commit messages with the Shortcut story number:
[sc-123] add event creation
[sc-456] resolve date picker issue
[sc-789] update API reference
[sc-101] upgrade dependenciesCode Review
Before Requesting Review
- [ ] Code builds without errors
- [ ] Linting passes (
npm run lint) - [ ] Self-review your changes
- [ ] Update relevant documentation
Merge Process
- Create PR from feature branch to
develop - Request review from teammate
- Address any feedback
- Merge when approved
Deployment Flow
feature/* → develop → qa → main
↓ ↓ ↓
Dev Env QA Env ProductionAll deployments happen automatically via GitHub Actions when branches are updated.