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
devand 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
-
Push your branch to remote:
git push origin feature/your-feature-name -
Create Pull Request:
- Go to the repository on GitHub/GitLab
- Click "New Pull Request"
- Select
devas the base branch (notmain) - Select your feature branch as the compare branch
- Fill out the PR template (if available)
-
PR Title Format:
[Type] Brief descriptionExamples:
[Feature] Add user authentication[Fix] Resolve signature validation error[Refactor] Optimize data fetching logic
-
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