diff --git a/.github/ISSUE_TEMPLATE/AGENTS.md b/.github/ISSUE_TEMPLATE/AGENTS.md index d9580c7..910863e 100644 --- a/.github/ISSUE_TEMPLATE/AGENTS.md +++ b/.github/ISSUE_TEMPLATE/AGENTS.md @@ -4,6 +4,8 @@ ## 约束 +- 模板字段必须服务于复现、定位和归类。 - 字段保持简洁,优先收集问题、期望结果、复现路径和相关链接。 - 不加入无意义的长免责声明。 -- 不要求用户公开敏感信息。 +- 不要求用户公开隐私信息、密钥、Token 或账号凭证。 +- 模板变更后运行 `make lint` 或 `make test` 检查 Markdown 格式。 diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md index 7fd9898..cb5a47b 100644 --- a/.github/ISSUE_TEMPLATE/README.md +++ b/.github/ISSUE_TEMPLATE/README.md @@ -1,9 +1,3 @@ # .github/ISSUE_TEMPLATE Issue 模板目录,用于统一反馈、纠错、资料补充和问题报告格式。 - -## 维护规则 - -- 模板字段必须服务于复现、定位和归类。 -- 不要求用户提交隐私信息、密钥或账号凭证。 -- 模板变更后检查 Markdown 格式。 diff --git a/.github/workflows/README.md b/.github/workflows/README.md index c1d1a22..726a25c 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -5,9 +5,3 @@ GitHub Actions 工作流目录。 ## 当前工作流 - `ci.yml` - Markdown lint、本地链接、docs 结构、目录治理、metadata、AI citation 和外链检查。 - -## 维护规则 - -- 优先复用 `Makefile` 和 `scripts/` 中已有门禁。 -- 外链检查排除规则放在 `.lychee.toml`。 -- action 版本升级后必须观察远端 CI 结果。 diff --git a/README.md b/README.md index d8151a9..36dca90 100644 --- a/README.md +++ b/README.md @@ -462,7 +462,7 @@ pip install -r tools/prompts-library/scripts/requirements.txt │ ├── getting-started/ # 从零开始、学习地图、环境与 AI CLI 配置 │ ├── concepts/ # 核心概念、方法论与底层模型 │ ├── philosophy/ # 哲学方法论与底层认知模型 -│ ├── references/ # 清单、约束、常见坑与模板(总文档由 sources/ 生成) +│ ├── references/ # 清单、约束、常见坑、模板和技术栈参考 │ └── research/ # 新技术、优秀 repo 与工程范式研究 ├── prompts/ # 提示词库入口(指向云端表格) ├── skills/ # 技能库入口 diff --git a/Workflow/AGENTS.md b/Workflow/AGENTS.md index 4ebb69a..938ed5c 100644 --- a/Workflow/AGENTS.md +++ b/Workflow/AGENTS.md @@ -6,11 +6,13 @@ ## 修改规则 +- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。 - 新增流程文档时,优先使用 Markdown。 -- 流程必须写成可执行步骤,避免只写抽象口号。 +- 新增流程必须能被执行、检查和复用,避免只写抽象口号。 - 涉及命令、路径、配置、CI、Git 操作时,必须与仓库当前事实一致。 - 不在本目录保存密钥、Token、本地账号、真实私有项目配置或一次性日志。 - 架构、目录、命令或质量门禁发生变化时,同步更新本目录和根 `README.md` / `AGENTS.md`。 +- 不确定项标注 TODO,并说明需要哪个文件或命令输出才能确认。 ## 验证 diff --git a/Workflow/README.md b/Workflow/README.md index 9273717..b3a48cc 100644 --- a/Workflow/README.md +++ b/Workflow/README.md @@ -5,7 +5,6 @@ ## 目录 - [开发流程](#开发流程) -- [维护规则](#维护规则) ## 开发流程 @@ -20,10 +19,3 @@ 7. 控制版本:使用语义清晰的 commit 记录阶段性成果。 8. 推送远端:默认推送当前 `develop` 分支,并观察 GitHub Actions 结果。 9. 同步文档:目录、命令、配置、流程变化必须同步 README / AGENTS / 对应索引。 - -## 维护规则 - -- 本目录只放流程类文档,不放一次性任务记录、日志、源码快照或私密配置。 -- 新增流程必须能被执行、检查和复用。 -- 流程中出现的命令、路径和配置必须能在仓库中找到依据。 -- 不确定项标注 TODO,并说明需要哪个文件或命令输出才能确认。