Upcoming Change: Switching from GitFlow to GitHub Flow

[camUrban]

Summary

We’re switching our branching and release process from GitFlow to GitHub Flow. This will simplify our workflow, reduce merge overhead, and better align with our CI/CD practices.

What’s Changing

• Old: GitFlow: multiple long-lived branches (develop, master) plus release-*, feature, and hotfix-* branches.
• New: GitHub Flow: one long-lived branch (main) with short-lived feature branches for all new work.

New Workflow

1. Create a branch from main for each change.
2. Open a pull request (PR) early for discussion and review.
3. Merge to main once review and automated checks pass.
4. Release cadence: ~monthly version bump and deployment to GitHub and PyPI, plus on-demand releases for critical bug fixes.

Why the Change

1. Simpler branching: no develop branch.
2. Faster releases: every merge to main is production-ready.
3. Easier onboarding: one straightforward branching model.

Action Required

• Review the GitHub Flow guide.
• Create all new feature branches from main and submit PRs to main.

Additional Notes

• master will be renamed main.
• develop will be archived.
• Documentation (CONTRIBUTING.md, README.md) and CI/CD will be updated to deploy from main.