docs(agents): retire the six role briefs under .github/instructions/ - #1977
Merged
Merged
Conversation
…s into AGENTS.md First commit of #1832 is a reading, not a deletion. Each of the six .github/instructions/ briefs was diffed against AGENTS.md; the only necessary content AGENTS.md lacked came from logic.md: - the ctx.api method contract lives in the _hook-api.ts types (count takes where only, reads cap with top, update is (doc with id, {where})); - hook handlers and script action bodies run body-only in a QuickJS sandbox with no module scope, gated by declared capabilities; - ctx.user is absent on system and seed writes. The measured traps (role/permission/rls files, validation: singular, default-export views, unprefixed object: names) are not folded back. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X8U3asekbiC7yWoEPWR4Dg
AGENTS.md is the one instruction set. Delete architect, automation, logic, metadata, security and ui briefs; drop .github/instructions/** from the governed-paths list; retire the docs-src-tree-paths block that guarded only those files (AGENTS.md stays enrolled in TREE_DOCS); and re-point the .github/tasks prompts and AGENT_GUIDE.md at AGENTS.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X8U3asekbiC7yWoEPWR4Dg
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
This was referenced Oct 1, 2026
This was referenced Oct 2, 2026
Contributor
Author
维护者速读(终稿)
改了什么
为什么改 风险与代价(含回滚)
席位意见 你要做的 Generated by Claude Code |
This was referenced Oct 2, 2026
os-zhuang
approved these changes
Oct 3, 2026
os-zhuang
marked this pull request as ready for review
October 3, 2026 03:04
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1832
Ruling: batch #142 item 4, option B (maintainer 「同意」, comment 5696850948), plus the
.github/tasks/*scope addition in comment 5825877235.维护者速读(草稿)
.github/instructions/下六份角色简报(architect / automation / logic / metadata / security / ui)全部删除,AGENTS.md 成为唯一的一套指令。logic.md里有 AGENTS.md 缺的必要内容,已并入「Tech Stack」第 3 条:沙箱只执行函数体、不能引用模块作用域;action 只能在声明的 capabilities 下访问数据;系统/种子写入时没有ctx.user;方法契约以_hook-api.ts类型为准。已测实的陷阱(*.role.ts/*.permission.ts/*.rls.ts、单数validation:、default-export 视图、不带crm_的object:)没有并回。.github/instructions/**;.github/tasks/*与.github/AGENT_GUIDE.md里指向简报的 5 处引用改指 AGENTS.md;两个测试里只守简报路径的钉子同步移除。src/、配置或发布产物;回滚即 revert 本 PR。.github/instructions/**),保持 draft,合并由维护者本人点击。The reading (first commit, ffb4036)
Each brief was diffed against AGENTS.md on
origin/main(a228df1, post-#1910src/package layout).architect.mdautomation.mdworkflownote; §2's flow example isexport default(not theAutomation.Flowtyped literal); §3*.trigger.tsis the ruling's unanswered questionmetadata.mdObjectSchema.create, barrel registration and field types are in AGENTS.md; §3 is thevalidation:trapsecurity.mdui.mdobject:logic.mdFolded into AGENTS.md §Tech Stack rule 3 (two new sub-bullets, each re-measured against
src/before writing):ctx.apimethod contract is thesrc/sales/objects/_hook-api.tstypes:counttakeswhereonly (HookCountQuery), reads cap withtop(HookQuery),updateis(doc carrying its id, { where })(HookUpdateDoc/HookUpdateOptions).scriptaction bodies run body-only in a QuickJS sandbox with no module scope (test/action-sandbox.test.tslowers every registered hook viaallHooks); action bodies reach data only under declaredcapabilities(src/*/actionsdeclareapi.read/api.write);ctx.useris absent on system and seed writes (relied on inopportunity_line_item.hook.ts,quote.hook.ts,account.hook.ts,contact.hook.ts).The path
test/docs-src-tree-paths.test.tspinned inlogic.mdwassrc/sales/objects/_hook-api.ts; AGENTS.md already names it and is already enrolled in that file'sTREE_DOCS, so the pin's subject survives.Not folded, deliberately: the measured traps listed in the ruling;
logic.md's operator table (a platform vocabulary, and rejected spellings answer loudly with 400); its hook-event list (the schema enum rejects other spellings); and its claim that a hook needs "no barrel entry", which is itself stale:src/*/objects/hooks.tsare the four registration barrels AGENTS.md already names.Deleted
.github/instructions/architect.md,automation.md,logic.md,metadata.md,security.md,ui.md(616 lines).Re-pointed references (full grep for
.github/instructions,instructions/and the brief file names, excludingCHANGELOG.md).github/tasks/autonomous_feature_dev.md:5:/load .github/instructions/architect.mdto/load AGENTS.md.github/tasks/autonomous_feature_dev.md:14: the "Feature-to-File Mapping Strategy inarchitect.md" to the layout rules in AGENTS.md §Project Architecture (the file table it asks for is kept).github/tasks/new-feature.md:21:.github/instructions/metadata.mdtoAGENTS.md.github/AGENT_GUIDE.md:5: theinstructions/handbook entry to/AGENTS.md, the one instruction set.github/AGENT_GUIDE.md:14: review againstinstructions/to review against/AGENTS.mdAGENTS.mdgoverned-paths list:.github/instructions/**droppedCLAUDE.mdand.github/copilot-instructions.mdname no brief and are unchanged.CHANGELOG.mdhas one historical mention, left as release history.Test edits (pins on the retired paths only)
test/docs-src-tree-paths.test.ts: the .github/instructions/logic.md points its action example at packages/crm/src/ — a layout hotcrm does not have, and no gate covers that directory #1233 block (INSTRUCTIONS_DIR,instructionFiles,PACKAGES_PATH,PENDING_PACKAGES_REFS,INSTRUCTION_TREE_DOCS,srcPackagesand its describe) guarded only.github/instructions/*.mdand is removed, with a one-paragraph note in its place. The maintainer-doc, product-doc and tree-diagram rules (which cover AGENTS.md) and the extractor unit pins are untouched.test/docs-drift.test.ts: the SPLIT BY FAMILY table row no longer names the briefs.No skip, no quarantine, no new gate, test or lint rule.
Verification
pnpm install --frozen-lockfile --prefer-offlinethenpnpm verifyat 54c5bad:os-verify-lock: VERDICT command-exit 0. validate✓ Validation passed; typecheck; lint (exit 0, pre-existing flow expression warnings only); lint:i18n-gate0 i18n/missing-* issues; hygiene✓ source hygiene clean; hygiene:tokens; build; testTest Files 173 passed (173),Tests 3721 passed | 1 skipped (3722).Changeset:
.changeset/retire-role-briefs.md, empty frontmatter (agent instructions only, nothing ships).Acceptance notes
.github/AGENT_GUIDE.mdwas outside the claim's listed file surface but inside the dispatch's "any other file that references.github/instructions, re-pointed only" clause.Generated by Claude Code