Add AGENTS.md + tighten contribution flow
- AGENTS.md: public contributor/agent guide (two-file rule, model-centric ids, one-entry-per-harness, bilingual notes, screenshot proof) - PR template: require a generation proof screenshot; drop the manual update-registry step; add id-naming and no-README-edit checks - CI: PRs only run validate-data; pushes to main auto-regenerate and commit the README registry (contents:write on that job, [skip ci], no loop) - README/update-registry: reflect auto-synced registry; fix stale 'two cases' -> three (mythos-craft, pelican-cycling, skeleton-watch); link AGENTS.md Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
2fb8499fa8
commit
30983f0e7d
6 files changed
+167
-26
No files matched your search
@@ -1,19 +1,33 @@
|
||||
<!-- 感谢贡献!只需两类文件:outputs/<model-id>/<case-id>.<ext> + models/<model-id>.json -->
|
||||
<!-- Thanks for contributing! Only two kinds of files: the artifact + the JSON registration. -->
|
||||
<!-- 感谢贡献!只需两类文件:outputs/<artifactDir>/<case-id>.<ext> + models/<model-id>.json -->
|
||||
<!-- Thanks for contributing! Only two kinds of files: the artifact + the JSON registration. 详见 AGENTS.md -->
|
||||
|
||||
## 产出说明 / Run info
|
||||
|
||||
- 模型 / Model:
|
||||
- 运行环境 / Harness(如 ChatGPT Web、Claude Code、Google AI Studio、本地 CLI…):
|
||||
- 思考配额 / Thinking effort(如 Max、High、Extended Pro、Thinking…):
|
||||
- 是否一次生成 / One-shot? (是/否;若有修复请在 note 里说明 / if fixed, document it in the note)
|
||||
- 厂商 / Vendor:
|
||||
- 运行环境 / Harness(如 ChatGPT Web、Claude Code、Codex CLI、AntiGravity…,这是工具不是模型):
|
||||
- 思考配额 / Thinking effort(如 Max、High、xhigh、Extended Pro、Thinking…):
|
||||
- 是否一次生成 / One-shot?(是/否;若有修复请在 note 里说明 / if fixed, document it in the note)
|
||||
|
||||
## 生成凭证截图 / Proof screenshot **(required)**
|
||||
|
||||
<!-- 直接把图片拖进下面,GitHub 会托管它。不要把图片文件提交进仓库。 -->
|
||||
<!-- Drag the image in below; GitHub hosts it. Do NOT commit image files into the repo. -->
|
||||
|
||||
请贴一张**生成过程截图**:你的 harness / IDE 中能看到**模型名 + 思考配额**正在产出本产物,
|
||||
作为「确实用了这套 harness + 模型 + effort」的凭证。
|
||||
Please attach a screenshot of the generation showing the **model name + effort** in your harness/IDE.
|
||||
|
||||
## 自查 / Checklist
|
||||
|
||||
- [ ] `models/<model-id>.json` 中 `harness` 与 `effort` 已如实填写(站点据此生成 metadata 与品牌 icon)
|
||||
- [ ] 每条 run 的 `note` 双语(zh + en)填写了上面的来历信息 / bilingual `note` documents the provenance above
|
||||
- [ ] 只改了两类文件:`outputs/<artifactDir>/<case-id>.<ext>` + `models/<model-id>.json` / only the artifact + its JSON
|
||||
- [ ] **没有**手改 `README.md` / `README.en.md`(注册表合并后由 CI 自动同步)/ did **not** hand-edit the README registry (auto-synced after merge)
|
||||
- [ ] 模型 id 用短横线、以**模型**命名(非 harness),如 `deepseek-v4-flash-reasonix` / dash-case id named after the model, not the harness
|
||||
- [ ] `harness` 与 `effort` 如实填写(站点据此生成 metadata 与品牌 icon)/ `harness` and `effort` are accurate
|
||||
- [ ] 每条 run 的 `note` 双语(zh + en,zh 先,无 emoji)填了来历 / bilingual `note`, zh first, no emojis
|
||||
- [ ] 同一模型换 Harness 或思考配额是**新建一个 JSON 条目** / a different harness or effort = a NEW json entry
|
||||
- [ ] `contributor` 是我的 GitHub 用户名 / `contributor` is my GitHub username
|
||||
- [ ] 同一模型在不同 Harness 或思考配额下是**新建一个 JSON 条目**,不是塞进现有条目 / a different harness or effort = a NEW json entry, not a variant
|
||||
- [ ] 已运行 `bun scripts/update-registry.ts` 更新 README Registry 表 / ran `bun scripts/update-registry.ts` to refresh the README Registry tables
|
||||
- [ ] 已贴生成凭证截图 / attached the proof screenshot above
|
||||
- [ ] 本地 `bun scripts/validate-data.ts` 通过 / `bun scripts/validate-data.ts` passes locally
|
||||
|
||||
<!-- CI 会跑数据校验 + 构建;规则详见 README「贡献一个模型产出」。 -->
|
||||
<!-- 规则详见 AGENTS.md。CI 只跑数据校验;README Registry 在合并到 main 后由 CI 自动重生成。 -->
|
||||
@@ -14,11 +14,35 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: oven-sh/setup-bun@v2
|
||||
- name: Check README registry
|
||||
run: bun scripts/update-registry.ts --check
|
||||
- name: Validate contribution data
|
||||
run: bun scripts/validate-data.ts
|
||||
|
||||
sync-registry:
|
||||
# The README Registry tables are generated from models/*.json. Contributors
|
||||
# do not edit them by hand; on every push to main we regenerate and commit
|
||||
# any drift back. Commits pushed with GITHUB_TOKEN do not retrigger
|
||||
# workflows, and the message carries [skip ci] too, so there is no loop.
|
||||
if: github.event_name == 'push'
|
||||
needs: validate
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: oven-sh/setup-bun@v2
|
||||
- name: Regenerate README registry
|
||||
run: bun scripts/update-registry.ts
|
||||
- name: Commit if registry drifted
|
||||
run: |
|
||||
if git diff --quiet -- README.md README.en.md; then
|
||||
echo "Registry already in sync."
|
||||
exit 0
|
||||
fi
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git commit -am "chore: sync README registry [skip ci]"
|
||||
git push origin HEAD:main
|
||||
|
||||
trigger-site-rebuild:
|
||||
# The site lives in the private nagi-bench-site repo (Cloudflare Pages).
|
||||
# With SITE_DISPATCH_TOKEN set the rebuild is instant; without it the
|
||||
|
||||
Reference in new issue
Block a user