Skip to content

Commit cf65b19

Browse files
theonlyhennygodPlebCoder
authored andcommitted
docs: add branching model section to CONTRIBUTING.md (zeroclaw-labs#3237)
Adds a prominent Branching Model section to CONTRIBUTING.md explaining: - master is the sole default branch (main has been removed) - Contributors should use feat/* and fix/* branches off master - Historical context for the migration (refs zeroclaw-labs#2929, zeroclaw-labs#3061, zeroclaw-labs#3194) Also updates fork workflow instructions to show both feat/ and fix/ prefixes.
1 parent aefe094 commit cf65b19

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

ā€ŽCONTRIBUTING.mdā€Ž

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
Thanks for your interest in contributing to ZeroClaw! This guide will help you get started.
44

5+
## Branching Model
6+
7+
> **Important — `master` is the default branch.**
8+
>
9+
> ZeroClaw uses **`master`** as its single source-of-truth branch. The `main` branch has been removed.
10+
>
11+
> Previously, some documentation and scripts referenced a `main` branch, which caused 404 errors and contributor confusion (see [#2929](https://github.com/zeroclaw-labs/zeroclaw/issues/2929), [#3061](https://github.com/zeroclaw-labs/zeroclaw/issues/3061), [#3194](https://github.com/zeroclaw-labs/zeroclaw/pull/3194)). As of March 2026, all references have been corrected and the `main` branch deleted.
12+
>
13+
> **How contributors should work:**
14+
> 1. Fork the repository
15+
> 2. Create a `feat/*` or `fix/*` branch from `master`
16+
> 3. Open a PR targeting `master`
17+
>
18+
> Do **not** create or push to a `main` branch.
19+
520
## First-Time Contributors
621

722
Welcome — contributions of all sizes are valued. If this is your first contribution, here is how to get started:
@@ -15,7 +30,7 @@ Welcome — contributions of all sizes are valued. If this is your first contrib
1530

1631
3. **Follow the fork → branch → change → test → PR workflow:**
1732
- Fork the repository and clone your fork
18-
- Create a feature branch (`git checkout -b fix/my-change`)
33+
- Create a feature branch (`git checkout -b feat/my-change` or `git checkout -b fix/my-change`)
1934
- Make your changes and run `cargo fmt && cargo clippy && cargo test`
2035
- Open a PR against `master` using the PR template
2136

0 commit comments

Comments
Ā (0)
⚔