mirror of
https://github.com/Brotocol-xyz/bro-sdk.git
synced 2026-01-12 22:25:00 +08:00
docs: add docs/project-branch-model.md to illustrate the branch model
This commit is contained in:
40
docs/project-branch-model.md
Normal file
40
docs/project-branch-model.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Project Branch Model
|
||||
|
||||
## Branch Structure
|
||||
|
||||
- `master`
|
||||
- `snapshots/*` (including `feature/*`, `fix/*`, etc.)
|
||||
- `releases/latest`
|
||||
- `releases/v*`
|
||||
|
||||
## Branch Descriptions
|
||||
|
||||
### Main Branch
|
||||
|
||||
The `master` branch is our blessed branch, has the latest code and documentation.
|
||||
|
||||
### Working Branches
|
||||
|
||||
`snapshots/*`, `feature/*`, `fix/*`, and other similar branches are used as working branches for ongoing development.
|
||||
|
||||
### Release Branches
|
||||
|
||||
- `releases/v*`: Specific version release branches
|
||||
- `releases/latest`: Always points to the latest release branch
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Development occurs in working branches (`snapshots/*`, `feature/*`, `fix/*`, etc.).
|
||||
|
||||
2. Periodic pull requests are created from working branches to `master`, allowing team members to review changes and update corresponding documents.
|
||||
|
||||
3. After `master` is updated, working branches are rebased onto `master` to continue development.
|
||||
|
||||
4. For public releases:
|
||||
- Version number is bumped
|
||||
- Changes are merged into `releases/v*` branches
|
||||
|
||||
5. Cloudflare tracks all `releases/*` branches, building and hosting documentation for each version.
|
||||
|
||||
6. The `releases/latest` branch is updated to reference the most recent release, ensuring the latest documentation is always available.
|
||||
|
||||
Reference in New Issue
Block a user