[PR #40] [MERGED] docs: bootstrap AGENTS.md + CLAUDE.md shim (BE-3582) #49

New issue

Closed

opened 2026-10-26 22:35:43 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:35:43 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/github-workflows/pull/40
Author: @mattmillerai
Created: 7/19/2026
Status: ✅ Merged
Merged: 7/19/2026
Merged by: @mattmillerai

Base: main ← Head: matt/be-3582-agents-md

📝 Commits (1)

f51471f docs: bootstrap AGENTS.md + CLAUDE.md shim (BE-3582)

📊 Changes

2 files changed (+110 additions, -0 deletions)

View changed files

➕ AGENTS.md (+108 -0)
➕ CLAUDE.md (+2 -0)

📄 Description

ELI-5

Agents (Claude Code, Cursor, etc.) look for a file that tells them how to work in
a repo. The cross-tool standard is AGENTS.md; Claude Code specifically reads
only CLAUDE.md and won't fall back. This repo had neither, so agents touching
these shared CI workflows got zero guidance. This PR adds a tight AGENTS.md
(the real source of truth) and a one-line CLAUDE.md shim that imports it — so
every agent, including Claude, gets the same instructions.

What this does

AGENTS.md (108 lines) — authored from the repo's actual contents:
one-paragraph purpose, the exact build/test commands, the .github/ directory
map, the reusable-workflow catalog, and the repo's real conventions/gotchas
(public-repo caller-name masking, full-SHA pin policy, scripts-as-single-
source-of-truth tamper-proofing, the one-bumper rule, Conventional Commits +
(BE-####) suffix, semver major tags).
CLAUDE.md — exactly the canonical @AGENTS.md shim, nothing else.

Implements the 2026-07-15 "Pillar 1: Agentic Engineering" standard — the same
one this repo's own agents-md-integrity.yml workflow enforces on consumers.

Verification

python3 .github/agents-md-integrity/check_agents_md.py --root . → passes
(108 < 200-line ceiling, valid @AGENTS.md shim, no .cursorrules). Only the
warn-level "no CODEOWNERS DRI" note remains — see judgment calls below.
Every command listed in AGENTS.md was copied verbatim from the CI
test-*.yml run: steps and executed locally green:
- cursor-review tests — 19 passed
- agents-md-integrity tests — 18 passed
- bump-callers tests — 25 passed
Change is additive root-markdown only; no path-filtered test-* workflow
fires on these paths, so nothing existing is affected.

Judgment calls

CODEOWNERS left out of scope. The integrity checker emits a warn-level
"no DRI" note; it is not a failure, and picking a DRI is a decision the ticket
doesn't specify. Scoped this PR to AGENTS.md + CLAUDE.md per the ticket.
Adding a CODEOWNERS rule for AGENTS.md is a clean follow-up.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/github-workflows/pull/40 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 7/19/2026 **Status:** ✅ Merged **Merged:** 7/19/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `matt/be-3582-agents-md` --- ### 📝 Commits (1) - [`f51471f`](https://github.com/Comfy-Org/github-workflows/commit/f51471fbc6c685319c8c7f107a2857a8e495c578) docs: bootstrap AGENTS.md + CLAUDE.md shim (BE-3582) ### 📊 Changes **2 files changed** (+110 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `AGENTS.md` (+108 -0) ➕ `CLAUDE.md` (+2 -0) </details> ### 📄 Description ## ELI-5 Agents (Claude Code, Cursor, etc.) look for a file that tells them how to work in a repo. The cross-tool standard is `AGENTS.md`; Claude Code specifically reads only `CLAUDE.md` and won't fall back. This repo had neither, so agents touching these shared CI workflows got zero guidance. This PR adds a tight `AGENTS.md` (the real source of truth) and a one-line `CLAUDE.md` shim that imports it — so every agent, including Claude, gets the same instructions. ## What this does - **`AGENTS.md`** (108 lines) — authored from the repo's actual contents: one-paragraph purpose, the exact build/test commands, the `.github/` directory map, the reusable-workflow catalog, and the repo's real conventions/gotchas (public-repo caller-name masking, full-SHA pin policy, scripts-as-single- source-of-truth tamper-proofing, the one-bumper rule, Conventional Commits + `(BE-####)` suffix, semver major tags). - **`CLAUDE.md`** — exactly the canonical `@AGENTS.md` shim, nothing else. Implements the 2026-07-15 "Pillar 1: Agentic Engineering" standard — the same one this repo's own `agents-md-integrity.yml` workflow enforces on consumers. ## Verification - `python3 .github/agents-md-integrity/check_agents_md.py --root .` → **passes** (108 < 200-line ceiling, valid `@AGENTS.md` shim, no `.cursorrules`). Only the warn-level "no CODEOWNERS DRI" note remains — see judgment calls below. - Every command listed in `AGENTS.md` was copied verbatim from the CI `test-*.yml` `run:` steps and executed locally green: - cursor-review tests — 19 passed - agents-md-integrity tests — 18 passed - bump-callers tests — 25 passed - Change is additive root-markdown only; no path-filtered `test-*` workflow fires on these paths, so nothing existing is affected. ## Judgment calls - **CODEOWNERS left out of scope.** The integrity checker emits a warn-level "no DRI" note; it is not a failure, and picking a DRI is a decision the ticket doesn't specify. Scoped this PR to `AGENTS.md` + `CLAUDE.md` per the ticket. Adding a CODEOWNERS rule for `AGENTS.md` is a clean follow-up. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-26 22:35:43 +00:00