Skip to content

docs: document the branch model in AGENTS.md - #159

Merged
eric2003 merged 1 commit into
eric2003:masterfrom
lql341:pr/agents-branch-model
Sep 19, 2026
Merged

eric2003 merged 1 commit into
eric2003:masterfrom
lql341:pr/agents-branch-model

Conversation

@lql341

@lql341 lql341 commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

Adds a short "Branch model" section to AGENTS.md so agents and new contributors know how branches are meant to be used here.

  • Baseline branch (usually master): mirror of the upstream default branch, read-only PR baseline.
  • Working branch (dev, when the checkout has one): long-lived daily-work branch; keep it current by merging the upstream default branch, not by rebasing once pushed.
  • Topic branches: short-lived, created from the upstream default branch when a PR is authorized.

The wording is deliberately generic: the fork-specific names appear only in parentheses and the dev references are conditioned on the branch existing, so the section stays correct in the upstream repository as well.

Docs-only change: no code and no numerical impact, so it does not touch the CPU five-case regression gate described in AGENTS.md working rule 1.

Describe the baseline / working / topic branch split generically so the
section stays correct both in a fork checkout and in the upstream
repository. Condition the dev references on the branch existing, which
avoids dangling pointers upstream.
lql341 added a commit to lql341/OneFLOW that referenced this pull request Sep 19, 2026
- Fix the ahead count: the earlier 100 missed commit bc6d395, the real
  value is 102.
- Stop pinning the doc's own commit: its own commit advances dev, so
  point at git rev-parse instead of a hard-coded sha.
- Scope the gate claim correctly: only PR eric2003#160 ran the Kunshan gates;
  PR eric2003#159 is docs-only and rule 1 does not apply to it.
- Add the exact commands used to reproduce T1 and T2, including the
  amd_comgr_DIR caveat on the upstream runner.
@eric2003
eric2003 merged commit 41830b9 into eric2003:master Sep 19, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants