Skip to content

Update README with Release Branching Policy #6

@datakaitech

Description

@datakaitech

We need to update the main README.md to include our new release and branching workflow policy.
Currently, contributors might not be aware that all changes must go through the release branch before merging to master.

Add the following section under "🤝 Contributing (Join the guild)" in the README:

### 🐞 Release & Branching Policy Update

All future **code changes, bug fixes, or feature updates** must be committed to the **latest release branch** (e.g., `release_v_0.x.x`).  
Once tested and verified, these changes will be **merged into `master`**, which always represents the **latest stable version**.  
After successful testing, a **new release version** will be published on **PyPI**.

> ⚠️ Do not push directly to `master`. All merges must go through the release branch.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions