agentleFS
NeplichNeplich/dev-agent-skills/docs/AGENTS.md

dev-agent-skills

AGENTS.md8 starsChanged 2 months agoMITView on GitHub

文档记录当前可用的能力、操作方法与经过核实的事实。按读者任务组织内容,每个主题维护一个清晰入口。 需要长期保存需求、技术方案、API、决策或测试结果时,沿用项目合适的文档位置。内容详略以实际读者和维护价值为依据。更新文档时同步相关入口,合并重复说明,保留最终结论和必要证据。历史修改可通过 Git 查阅。 选择使用 frontmatter 时保持字段准确;状态值沿用所选文档格式。链接指向仓库内真实文件,标题锚点与目标标题一致。 已有可复用 E2E 用例优先作为回归依据。需要持久化时可使用 docs/qa/e2e/{feature_path}/,凭据保存在被 Git 忽略的本地账号文件中,报告保留经过脱敏的结果和证据。QA Skill 的用例、凭据和报告参考提供具体格式。 _internal/_generated/shared-contracts/ 由生成脚本维护,编辑源文件后重新生成。它们提供按需使用的协作和文档参考。 docs/changelog/changelog-v{version}.md 记录对应历史版本,根 CHANGELOG.md 提供索引。当前使用方式见 README 与架构说明。

The file

Files
AGENTS.md

文档说明

文档记录当前可用的能力、操作方法与经过核实的事实。按读者任务组织内容,每个主题维护一个清晰入口。

位置内容
根 README能力介绍、安装与首次使用
根 AGENTS.md本仓库维护方式与权限
docs/architecture.md当前能力组织与分发结构
docs/README.codex.mdCodex 安装方式与维护
docs/cookbook/Skill 维护与手动发布步骤
agents//README.md各插件的能力目录
agents//skills//专业方法、脚本、模板与参考
docs/changelog/已发布版本的事实记录

需要长期保存需求、技术方案、API、决策或测试结果时,沿用项目合适的文档位置。内容详略以实际读者和维护价值为依据。更新文档时同步相关入口,合并重复说明,保留最终结论和必要证据。历史修改可通过 Git 查阅。

选择使用 frontmatter 时保持字段准确;状态值沿用所选文档格式。链接指向仓库内真实文件,标题锚点与目标标题一致。

QA E2E 资产

已有可复用 E2E 用例优先作为回归依据。需要持久化时可使用 docs/qa/e2e/{feature_path}/,凭据保存在被 Git 忽略的本地账号文件中,报告保留经过脱敏的结果和证据。QA Skill 的用例、凭据和报告参考提供具体格式。

共享参考与版本记录

_internal/_generated/shared-contracts/ 由生成脚本维护,编辑源文件后重新生成。它们提供按需使用的协作和文档参考。

docs/changelog/changelog-v{version}.md 记录对应历史版本,根 CHANGELOG.md 提供索引。当前使用方式见 README 与架构说明。

uv run scripts/check_doc_contract.py

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.