Skip to main content

Pull Request Process

Target Branch: dev

All Pull Requests must target the dev branch, not main.

PR Requirements

Before creating a Pull Request, ensure:

  • Your branch is based on dev and up to date
  • All changes are committed to your feature branch
  • Local build succeeds (yarn build)
  • No TypeScript errors
  • Code follows project conventions

Creating a Pull Request

  1. Push your branch to remote:

    git push origin feature/your-feature-name
  2. Create Pull Request:

    • Go to the repository on GitHub/GitLab
    • Click "New Pull Request"
    • Select dev as the base branch (not main)
    • Select your feature branch as the compare branch
    • Fill out the PR template (if available)
  3. PR Title Format:

    [Type] Brief description

    Examples:

    • [Feature] Add user authentication
    • [Fix] Resolve signature validation error
    • [Refactor] Optimize data fetching logic
  4. PR Description:

    • Describe what changes were made
    • Explain why the changes were necessary
    • Reference any related issues
    • Include screenshots if UI changes

PR Review and Merge

  • ⚠️ All Pull Requests must be reviewed and merged by the repository owner
  • ⚠️ Do not merge your own Pull Requests
  • ⚠️ Wait for approval before merging

The repository owner will:

  • Review your code
  • Request changes if needed
  • Approve and merge when ready