Skip to content

Pull Request Guidelines

Creating Pull Requests

Branch Naming

Follow the pattern from Shortcut:

type/sc-[ticket-id]-description

Examples:

  • feature/sc-123-add-event-creation
  • bugfix/sc-456-fix-login-error

PR Template

When creating a PR, include:

  1. What - Brief description of changes
  2. Why - Context from Shortcut ticket
  3. 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 dependencies

Code Review

Before Requesting Review

  • [ ] Code builds without errors
  • [ ] Linting passes (npm run lint)
  • [ ] Self-review your changes
  • [ ] Update relevant documentation

Merge Process

  1. Create PR from feature branch to develop
  2. Request review from teammate
  3. Address any feedback
  4. Merge when approved

Deployment Flow

feature/* → develop → qa → main
              ↓        ↓      ↓
           Dev Env  QA Env  Production

All deployments happen automatically via GitHub Actions when branches are updated.

Built with ❤️ by the Jubiloop team