Commit f210b8e
chore: 清理冗余文档和重组文件
删除根目录冗余文档:
- MAKEFILE_GUIDE.md (Makefile 本身已有清晰注释和 help)
- SETUP_AUTO_FORMAT.md (配置文件本身就是文档)
- EXAMPLES.md (14K+ 行,工具 docstring 是更好的文档)
- COMPLETION_REPORT.md (开发过程文档,Git 历史已记录)
- TASK.md (任务计划,应使用 GitHub Issues 管理)
删除 .github 冗余文档:
- WORKFLOWS.md (workflow 配置文件本身就是文档)
- CODE_QUALITY.md (工具配置文件本身就是文档)
- BRANCH_PROTECTION.md (GitHub 设置说明,一次性文档)
- CHECKLIST.md (开发过程文档)
- SETUP_SUMMARY.md (安装总结,一次性文档)
文件重组:
- 移动 verify_completion.py 到 test_scripts/ 目录
保留核心文档:
- README.md (项目主文档)
- CONTRIBUTING.md (贡献指南)
- LICENSE (法律文件)
- .github/copilot-instructions.md (AI 编程指南)
- .github/pull_request_template.md (GitHub 模板)
- .github/ISSUE_TEMPLATE/*.md (GitHub Issue 模板)
理由: 代码和配置本身就是最好的文档,过多的额外文档反而增加维护负担和上下文复杂度。1 parent 2f694f2 commit f210b8e
File tree
11 files changed
+0
-3289
lines changed- .github
- test_scripts
11 files changed
+0
-3289
lines changedThis file was deleted.
0 commit comments