🌿 Branching Strategy

Cherry Studio implements a structured branching strategy to maintain code quality and streamline the development process.

Current model. main is the default branch for all active development — submit features, refactors, optimizations, and fixes here.

Main Branches

main: Main development branch
- Contains the latest development code
- Direct commits are not allowed - changes must come through pull requests
- Code may contain features in development and might not be fully stable
release/*: Release branches
- Created from main branch
- Contains stable code ready for release
- Only accepts documentation updates and bug fixes
- Thoroughly tested before production deployment

For details about the testplan branch used in the Test Plan, please refer to the Test Plan.

When contributing to Cherry Studio, please follow these guidelines:

Feature Branches:
- Create from main branch
- Naming format: feature/issue-number-brief-description
- Submit PR back to main
Bug Fix Branches:
- Create from main branch
- Naming format: fix/issue-number-brief-description
- Submit PR back to main
Documentation Branches:
- Create from main branch
- Naming format: docs/brief-description
- Submit PR back to main
Hotfix Branches:
- Create from main branch
- Naming format: hotfix/issue-number-brief-description
- Submit PR back to main
Release Branches:
- Create from main branch
- Naming format: release/version-number
- Used for final preparation work before version release
- Only accepts bug fixes and documentation updates
- After testing and preparation, merge back to main and tag with version

Active development (features, refactors, optimizations, and fixes) goes to main
Ensure your branch is up to date with the latest main changes before submitting
Include relevant issue numbers in your PR description
Make sure all tests pass and code meets our quality standards
Add before/after screenshots if you add a new feature or modify a UI component