Git Workflow & Branching Strategy
Branching Model:
main: Always reflects production‑ready state.develop(optional): Integration branch for merged features before release.feature/*: New features or enhancements; branch offmainordevelop.bugfix/*: Critical fixes; branch offmainordevelop.release/*: Prepares code for a new production release; only bug fixes and documentation updates allowed.hotfix/*: Urgent fixes to production; branch offmainand merged back intomainanddevelop.
Naming Conventions:
Feature branches:
feature/short-summary(e.g.,feature/order-book-pagination).Bugfix branches:
bugfix/issue-number-description(e.g.,bugfix/142-fix-null-pointer).Release branches:
release/vX.Y.Z(e.g.,release/v1.3.0).Hotfix branches:
hotfix/vX.Y.Z-critical-bug.
Release Process:
Create
release/vX.Y.Zfromdevelopormain.Update
CHANGELOG.mdwith release notes.Bump version in
package.jsonand smart‑contract artifacts.Merge
release/vX.Y.Zintomainand tag withvX.Y.Z.Merge
release/vX.Y.Zback intodevelop.Deploy to staging and, after verification, promote to production.
Pull Request Workflow:
All PRs must target the appropriate base branch.
Use issue referencing (
Closes #issue) to automate issue closure.Ensure PR passes CI (tests, lint, security scans) before merging.
Last updated