fix: restore AGENTS.md as product showcase + test fixture - #7
Merged
Conversation
Root AGENTS.md was removed in v1.1.0 because .gitignore excludes it, but it serves two critical purposes: 1. GitHub visitors see it as the project's agent governance showcase 2. test_audit.py uses it as a fixture to validate reference integrity Changes: - .gitignore: add !/AGENTS.md exception (root file tracked, other generated artifacts like CLAUDE.md/GEMINI.md still gitignored) - Regenerate AGENTS.md from current source (coding profile, skeleton) - ci.yml: add freshness check step — regenerates and diffs AGENTS.md, fails if committed copy is stale
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
1 participant
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.
关联 Issue
Relates to #5 (v1.1.0 removal was too aggressive)
问题
v1.1.0 移除了根 AGENTS.md（因为是生成产物），但忽略了两个关键用途：
test_audit.py的 2 个测试用 AGENTS.md 验证引用完整性，移除后 CI 中永久跳过修复
.gitignore：添加!/AGENTS.md例外，根文件入库，其他生成产物（CLAUDE.md/GEMINI.md 等）仍过滤AGENTS.md：从当前源码重新生成（coding profile, skeleton 模式）ci.yml：新增 "Check AGENTS.md freshness" 步骤 — 重新生成并 diff，过期则 CI 失败验证