Skip to content

docs: add perf-changelog entries only when collecting results - #3803

Draft
adibarra wants to merge 6 commits into
mainfrom
docs/changelog-policy
Draft

adibarra wants to merge 6 commits into
mainfrom
docs/changelog-policy

Conversation

@adibarra

@adibarra adibarra commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

A perf-changelog.yaml entry is what triggers result collection, so add one only when a change should produce new published results. Refactors and recipe or config edits that are not meant to produce new results need no entry.

Changed:

  • AGENTS.md, CONTRIBUTING.md, RECIPES.md: state the new rule. The append-only, byte-sensitive and tail-only rules, one block per PR, English-only entries and append-only: true semantics are unchanged.
  • PR template: the changelog and sweep-label checkboxes follow the new rule.
  • claude.yml: the coding job adds an entry only when results are wanted, and asks when that is unclear. In the review job, a master-config edit without an entry is no longer blocking; the bot asks once whether the author intends to collect results.

Not changed: CODEOWNER sign-off Check 1 and PR_REVIEW_CHECKLIST.md still require a green sweep before sign-off. Changing that merge standard is a separate decision.

A perf-changelog.yaml entry is what triggers result collection, so add
one only when a change should produce new published results. Refactors
and recipe or config edits that are not meant to produce new results
need no entry.

Reword the old rule that every performance-affecting change and every
recipe addition or modification needs an entry in AGENTS.md,
CONTRIBUTING.md, the multi-node RECIPES.md guide, the PR template, and
the Claude workflow prompts. The review prompt no longer blocks a PR
that edits master configs without an entry; it asks, without blocking,
whether the author intends to collect results.

The append-only byte rules, one block per PR, English-only entries, and
append-only: true semantics are unchanged.
@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Thanks for the contribution!

  • Review: If this PR changes files owned by someone other than a repository admin or @SemiAnalysisAI/core, ask one eligible CODEOWNER to complete the latest PR_REVIEW_CHECKLIST.md before contacting a core maintainer on Slack. Follow the template exactly, including As a PR reviewer and CODEOWNER, I have reviewed this and have, so sign-off verification triggers.
  • PR verification: Sweeps run only when the PR appends an inferencex-e2e/perf-changelog.yaml entry and carries exactly one primary label: full-sweep-fail-fast (strongly recommended; canary plus per-matrix fail-fast), full-sweep-enabled (canary; matrix jobs continue after a failure), or non-canary-full-sweep-enabled (no canary or fail-fast). The modifiers all-evals, evals-only, and agentx-fast require a primary label. On fork PRs, a maintainer applies the label. See sweep labels and reuse.
  • After merging: PR authors must ensure all GitHub Actions jobs pass. Transient failures often pass on rerun; see how to rerun failed jobs.
中文

感谢你的贡献!

  • **审阅:**如果 PR 修改的文件归属于仓库管理员及 @SemiAnalysisAI/core 之外的 CODEOWNER,请先联系一位有资格的 CODEOWNER 填写最新的 PR_REVIEW_CHECKLIST.md,再通过 Slack 联系核心维护者。必须严格遵循模板,并保留 As a PR reviewer and CODEOWNER, I have reviewed this and have,才能触发签核验证。
  • **PR 验证:**只有当 PR 在 inferencex-e2e/perf-changelog.yaml 末尾追加了条目,并且恰好带有一个主标签时,才会运行扫描:full-sweep-fail-fast(强烈推荐;canary 加逐矩阵 fail-fast)、full-sweep-enabled(有 canary;矩阵任务在失败后继续运行)或 non-canary-full-sweep-enabled(无 canary,也无 fail-fast)。修饰标签 all-evals、evals-only 和 agentx-fast 必须与主标签一起使用。fork PR 的标签由维护者添加。参见扫描标签与复用。
  • **合并后:**PR 作者必须确保所有 GitHub Actions 任务通过。临时性失败通常可以通过重新运行恢复;参见重新运行失败任务的说明。

State the rule in one sentence: add an entry only when the change should produce new published results, not for every recipe or config edit. Trim the review prompt's non-blocking instructions. The Chinese pages mirror the English text.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant