github/deer-flow
1
0
Fork 0
mirror of https://github.com/bytedance/deer-flow.git synced 2026-10-29 22:50:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: keep version guidance within inherited size budget

Browse Source
This commit is contained in:
Willem Jiang 2026-10-29 20:42:07 +08:00
parent c133f5e0da
commit 9a79f97aef
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
AGENTS.md
View File

@ -238,14 +238,12 @@ Repo-wide conventions:
- **Skill text encoding** — use explicit UTF-8 for textual skill resources.
Read `SKILL.md` with `encoding="utf-8-sig"` to strip a leading BOM; write with
`encoding="utf-8"`. Never rely on the platform locale.
- **Version sources must stay in lockstep** — a release version must match identically in
`backend/pyproject.toml`, `backend/packages/harness/pyproject.toml`, `frontend/package.json`,
and `deploy/helm/deer-flow/Chart.yaml` (`version` + `appVersion`), and `backend/uv.lock` must
record the same version for the root `deer-flow` and `deerflow-harness` workspace members
(uv stores its PEP 440 form, e.g. `2.1.0rc0`). Pushing a `v*` git tag triggers CI
that runs `scripts/verify_versions.sh` and **blocks all publishing** if any source drifts.
Before bumping a version, run `scripts/bump_version.sh <ver>` (aligns the five fields and
refreshes `backend/uv.lock` at once — it needs `uv` on `PATH`) and
`scripts/verify_versions.sh <ver>` to catch drift early. See [RELEASING.md](RELEASING.md).
- **Version lockstep** — keep `backend/pyproject.toml`,
`backend/packages/harness/pyproject.toml`, `frontend/package.json`, and
`deploy/helm/deer-flow/Chart.yaml` (`version`/`appVersion`) identical.
`backend/uv.lock` must match both `deer-flow` and `deerflow-harness` in PEP 440 form.
Run `scripts/bump_version.sh <ver>` (requires `uv` on `PATH`) to update all five
fields and the lock, then `scripts/verify_versions.sh <ver>`. `v*` tag CI blocks
all publishing on drift. See [RELEASING.md](RELEASING.md).
- **Don't edit `CLAUDE.md`** — it only contains `@AGENTS.md`. All agent guidance changes
belong here in `AGENTS.md`; `CLAUDE.md` is a thin import shim.