Thank you for your interest in contributing! We follow a structured Git workflow to keep the project clean, stable, and production-ready at all times.
| Branch | Purpose |
|---|---|
master |
Stable, production-ready code. All releases are tagged from here. |
develop |
Active development branch. All new features go here first. |
release/x.y.z |
Pre-release branch for staging, QA, and final polish. |
-
Start from
develop:git checkout develop git checkout -b feature/your-feature-name
-
Make your changes and commit them.
-
Push your branch:
git push origin feature/your-feature-name
-
Open a Pull Request into
develop.
A new release/x.y.z branch must be created for every release.
-
Create a
release/branch frommaster:git checkout master git checkout -b release/1.2.0
-
Merge in
developor selected branches ifdevelopis not ready:git merge develop # or git merge feature/finished-feature git merge feature/another-complete-feature -
Polish, test, and fix issues as needed.
-
Merge back into
develop:git checkout develop git merge release/1.2.0 git push origin develop
-
Finalize the release:
git checkout master git merge release/1.2.0 git tag v1.2.0 git push origin master --tags
-
Delete the release branch:
git branch -d release/1.2.0 git push origin --delete release/1.2.0