You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -154,4 +154,57 @@ To uninstall: `bash uninstall.sh`
154
154
155
155
## Contributing
156
156
157
-
See [CONTRIBUTING.md](CONTRIBUTING.md).
157
+
Please follow the repository branching and pull-request workflow to ensure stable releases and predictable merges.
158
+
159
+
Branching & PR rules
160
+
161
+
- Always branch from an up-to-date `develop` branch:
162
+
- git fetch origin
163
+
- git checkout develop
164
+
- git pull
165
+
- Create a feature branch from `develop`:
166
+
- git checkout -b feature/your-feature develop
167
+
- Implement your changes and run tests locally:
168
+
- cargo test
169
+
- cargo build --release
170
+
- bash bench/run.sh # optional for performance-sensitive changes
171
+
- Push your branch and create a PR targeting `develop`:
172
+
- git push -u origin feature/your-feature
173
+
- gh pr create --base develop --head feature/your-feature -t "Short title" -b "Description of changes and tests"
174
+
- Request reviewers, ensure CI passes and address feedback.
175
+
- Merge into `develop` once approved (follow the repo's merge strategy).
176
+
177
+
Promotion to main
178
+
179
+
- On push to `develop`, a workflow will create or update a PR from `develop` → `main` for final review and merge.
180
+
- Maintainers should review the `develop`→`main` PR, ensure CI/status checks pass, then merge to `main`.
181
+
182
+
Branch protection & admin notes
183
+
184
+
- Protect `main` with branch protection rules: require PR reviews (1+), require passing status checks, disallow force pushes, and enable required linear history if desired.
185
+
- If history was rewritten (commit messages edited), collaborators must re-sync their local clones:
186
+
- git fetch origin
187
+
- git reset --hard origin/develop
188
+
- or re-clone the repository
189
+
190
+
Changelog (recent)
191
+
192
+
- 2026-04-06: Added `--codex` and `--antigravity` init scaffolding (scaffold-only; platform-specific integration may be required).
193
+
- 2026-04-06: Created `develop` branch and added a promotion workflow that creates/updates a PR from `develop` → `main` on push to `develop`.
- 2026-04-06: Deleted merged branches `iss-3/add-platforms-codex-antigravity`, `iss-5/fix-pt-strings`, and removed `feat/memory-subsystem` from the remote.
197
+
198
+
Benchmarks & running them
199
+
200
+
Benchmarks are in the `bench/` folder and can be run as follows:
201
+
202
+
```bash
203
+
cargo build --release
204
+
bash bench/run.sh
205
+
```
206
+
207
+
Reported results (macOS Apple Silicon; token estimate = chars/4) are shown in the "Benchmarks" table above. Re-run on your platform to verify and submit improvements as PRs.
208
+
209
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for additional guidelines and coding standards.
0 commit comments