Comfy-Org/pyisolate

Fork 0

mirror of https://github.com/Comfy-Org/pyisolate.git synced 2026-11-05 00:27:34 +00:00

[PR #21] docs: promote CLAUDE.md to AGENTS.md with Claude Code shim #21

New issue

Open

opened 2026-10-26 22:11:40 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:11:40 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/pyisolate/pull/21
Author: @mattmillerai
Created: 9/16/2026
Status: 🔄 Open

Base: main ← Head: matt/be-3565-promote-claudemd-to-agentsmd

📝 Commits (3)

227e5c5 docs: promote CLAUDE.md to AGENTS.md with Claude Code shim
2f27302 docs(AGENTS.md): fix version, label partial export list, add ruff format check
446055b docs(AGENTS.md): note tox lint's broader ruff scope vs the CI gate

📊 Changes

2 files changed (+128 additions, -124 deletions)

View changed files

➕ AGENTS.md (+126 -0)
📝 CLAUDE.md (+2 -124)

📄 Description

ELI-5

Different AI coding tools look for their instructions in different files. Claude Code reads CLAUDE.md; most other agents (Codex, Cursor, Amp) read AGENTS.md. Today this repo only has CLAUDE.md, so every non-Claude agent gets zero guidance. This PR makes AGENTS.md the single source of truth (the same content, plus small accuracy fixes) and leaves a tiny CLAUDE.md that just imports it, so every tool reads the same instructions.

What changed

Renamed CLAUDE.md → AGENTS.md (via git mv). The content is carried over except for the H1 heading and four review fixes, listed below.

Added a new CLAUDE.md containing exactly the canonical Claude Code shim:

<!-- Agent instructions live in AGENTS.md (the cross-agent standard). This is a Claude Code shim: Claude reads only CLAUDE.md, so the import below pulls AGENTS.md in. Don't add content here — edit AGENTS.md. -->
@AGENTS.md

Generalized the one Claude-specific line: the H1 heading # CLAUDE.md → # AGENTS.md, so the file's title matches its new name. This is the org standard's "generalize Claude-specific phrasing" step (the body's opening line was already generic — "Guidance for AI agents…"). Flagging it as the single judgment call in this PR.
Review fixes to AGENTS.md, from CodeRabbit: the stale version v0.10.1 is now the source version 0.10.2 (matching pyproject.toml and __init__.py); the __init__.py row now says "Key exports" and points to the full Public API Surface list; the Code quality block adds the CI gate's ruff format --check pyisolate tests; and a comment there notes that tox -e lint uses a broader . scope (example/, docs/, README.md) that is not clean today, which is why the commands listed match the CI gate instead.

Verification

Confirmed no .cursorrules exists (nothing to remove).
Confirmed the only CLAUDE.md reference anywhere in the repo is the new shim itself (grep -rn CLAUDE.md).
Confirmed no nested CLAUDE.md/AGENTS.md files exist — this is a root-only change.
Diffed the original CLAUDE.md against the new AGENTS.md: the only differences are the H1 line and the four review fixes listed above.
Doc-only change: CI (ruff/mypy/pytest over pyisolate tests) is unaffected by markdown; pre-commit's whitespace/EOF hooks pass (single trailing newline, no trailing whitespace on either file).

Provenance

Authored by: agent-work loop
Verified:
- grep -rn CLAUDE.md: only the shim references it.
- Diffing the original CLAUDE.md against AGENTS.md shows only the H1 line and the four review fixes.
- Manual EOF and trailing-whitespace check on both files: clean.
- The version and export facts were checked against pyproject.toml and pyisolate/__init__.py, and the ruff scope against .github/workflows/ci.yml. ruff check/ruff format --check on pyisolate tests pass; on . they report 20 lint errors in example/ and 9 unformatted files in example/, docs/ and README.md, all present on main too.
- No Python was touched. The red CI/Windows Tests jobs fail the same tests on main at the same base 8ff4733 (asyncio event-loop errors plus a cuda_wheels tag assertion), so they predate this PR.
Deviations:
- The H1 changed from # CLAUDE.md to # AGENTS.md, following the standard's "generalize Claude-specific phrasing" step.
- The four CodeRabbit doc-accuracy fixes (version, "Key exports" label, ruff format check, tox-scope note) mean AGENTS.md is no longer byte-identical to the old CLAUDE.md body.

Residual

None. All acceptance criteria are met: CLAUDE.md holds exactly the canonical shim, AGENTS.md carries the prior content (H1 and the review fixes aside), no .cursorrules exists, and there are no nested instruction files to migrate.

_{🔄 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/pyisolate/pull/21 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 9/16/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `matt/be-3565-promote-claudemd-to-agentsmd` --- ### 📝 Commits (3) - [`227e5c5`](https://github.com/Comfy-Org/pyisolate/commit/227e5c5a5f337f35d8bddcc0a636984cc9be5eb8) docs: promote CLAUDE.md to AGENTS.md with Claude Code shim - [`2f27302`](https://github.com/Comfy-Org/pyisolate/commit/2f273025c2a95b02c0b2a0e682d436c529f89c63) docs(AGENTS.md): fix version, label partial export list, add ruff format check - [`446055b`](https://github.com/Comfy-Org/pyisolate/commit/446055b7ef04c29fe532ee492aee698f6e34e3e6) docs(AGENTS.md): note tox lint's broader ruff scope vs the CI gate ### 📊 Changes **2 files changed** (+128 additions, -124 deletions) <details> <summary>View changed files</summary> ➕ `AGENTS.md` (+126 -0) 📝 `CLAUDE.md` (+2 -124) </details> ### 📄 Description ## ELI-5 Different AI coding tools look for their instructions in different files. Claude Code reads `CLAUDE.md`; most other agents (Codex, Cursor, Amp) read `AGENTS.md`. Today this repo only has `CLAUDE.md`, so every non-Claude agent gets zero guidance. This PR makes `AGENTS.md` the single source of truth (the same content, plus small accuracy fixes) and leaves a tiny `CLAUDE.md` that just imports it, so every tool reads the same instructions. ## What changed - Renamed `CLAUDE.md` → `AGENTS.md` (via `git mv`). The content is carried over except for the H1 heading and four review fixes, listed below. - Added a new `CLAUDE.md` containing exactly the canonical Claude Code shim: ```markdown  @AGENTS.md ``` - Generalized the one Claude-specific line: the H1 heading `# CLAUDE.md` → `# AGENTS.md`, so the file's title matches its new name. This is the org standard's "generalize Claude-specific phrasing" step (the body's opening line was already generic — "Guidance for AI agents…"). Flagging it as the single judgment call in this PR. - Review fixes to `AGENTS.md`, from CodeRabbit: the stale version `v0.10.1` is now the source version `0.10.2` (matching `pyproject.toml` and `__init__.py`); the `__init__.py` row now says "Key exports" and points to the full Public API Surface list; the Code quality block adds the CI gate's `ruff format --check pyisolate tests`; and a comment there notes that `tox -e lint` uses a broader `.` scope (example/, docs/, README.md) that is not clean today, which is why the commands listed match the CI gate instead. ## Verification - Confirmed no `.cursorrules` exists (nothing to remove). - Confirmed the only `CLAUDE.md` reference anywhere in the repo is the new shim itself (`grep -rn CLAUDE.md`). - Confirmed no nested `CLAUDE.md`/`AGENTS.md` files exist — this is a root-only change. - Diffed the original `CLAUDE.md` against the new `AGENTS.md`: the only differences are the H1 line and the four review fixes listed above. - Doc-only change: CI (ruff/mypy/pytest over `pyisolate tests`) is unaffected by markdown; pre-commit's whitespace/EOF hooks pass (single trailing newline, no trailing whitespace on either file). ## Provenance - **Authored by:** agent-work loop - **Verified:** - `grep -rn CLAUDE.md`: only the shim references it. - Diffing the original `CLAUDE.md` against `AGENTS.md` shows only the H1 line and the four review fixes. - Manual EOF and trailing-whitespace check on both files: clean. - The version and export facts were checked against `pyproject.toml` and `pyisolate/__init__.py`, and the ruff scope against `.github/workflows/ci.yml`. `ruff check`/`ruff format --check` on `pyisolate tests` pass; on `.` they report 20 lint errors in `example/` and 9 unformatted files in `example/`, `docs/` and README.md, all present on `main` too. - No Python was touched. The red CI/Windows Tests jobs fail the same tests on `main` at the same base 8ff4733 (asyncio event-loop errors plus a cuda_wheels tag assertion), so they predate this PR. - **Deviations:** - The H1 changed from `# CLAUDE.md` to `# AGENTS.md`, following the standard's "generalize Claude-specific phrasing" step. - The four CodeRabbit doc-accuracy fixes (version, "Key exports" label, ruff format check, tox-scope note) mean `AGENTS.md` is no longer byte-identical to the old `CLAUDE.md` body. ## Residual None. All acceptance criteria are met: `CLAUDE.md` holds exactly the canonical shim, `AGENTS.md` carries the prior content (H1 and the review fixes aside), no `.cursorrules` exists, and there are no nested instruction files to migrate. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-26 22:11:40 +00:00

No labels

pull-request

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Comfy-Org/pyisolate#21

No description provided.

Rows
Columns