SuperAPI AI 工具集

github-repository-standards

编程与开发

查看项目

更新于 10-15 09:41

技能介绍

用途

该技能面向 GitHub 仓库的架构与文档治理,目标是消除“根目录熵增”,强制推行“渐进式披露”。它把仓库根目录视为门厅,要求保持整洁,以体现架构成熟度。

主要能力

1. 最小根目录理念

根目录只应包含架构支柱,实现细节应放入子目录。允许出现在根目录的内容包括:src/、docs/、.github/、tools/、README.md、LICENSE、package.json(或 Cargo.toml)、.gitignore。

.config/ 策略:将工具配置(如 ESLint、Prettier 等)迁移到 .config/,并通过 CLI 参数或设置让工具指向该位置。

2. 世界级 README 结构

README 被视为转化漏斗,需在 30 秒内把用户从“这是什么?”引导到“npm install”。其结构包括:

  • Hero:Logo(透明 PNG)、一句话定位、徽章面板。
  • Nav:自动生成的目录。
  • Value:“动机”(为什么)与“用法”(收益)。
  • Visuals:“图表即代码”(Mermaid.js)、暗色模式自适应图片(<picture>)。

3. 三种工作模式

模式一:根目录卫生审计

  • 扫描根目录,识别杂乱文件(如 .eslintrc、.prettierrc、.dockerignore、deployment.yaml)。
  • 迁移计划:配置移至 .config/;社区文件(CONTRIBUTING.md、CODEOWNERS)移至 .github/;文档移至 docs/。
  • 粘合代码:提供具体的 package.json 脚本覆盖或 VS Code .settings.json 修改,使工具能找到迁移后的文件。

模式二:文档工程

  • 起草 README:徽章(状态、元数据、社交、活跃度,使用 Shields.io);快速开始(可复制粘贴的围栏代码块);图表(为架构生成 Mermaid.js 流程图)。
  • 无障碍检查:确保所有图片有有意义的 alt 文本;使用 <picture> 标签兼容暗色模式。

模式三:社区健康

  • 治理文件:确保 .github/ 包含 SECURITY.md、SUPPORT.md 和 issue 模板。
  • 引用:若为学术项目,确保根目录存在 CITATION.cff(检测所需)。

使用方式

该技能以“仓库架构师”角色运行,按上述三种模式执行审计、迁移与文档生成。具体调用方式、安装命令或集成步骤暂未提供。

适用场景

适用于需要规范化 GitHub 仓库结构、提升 README 质量、完善社区健康文件的开发项目,尤其适合开源项目或团队协作仓库。

限制

资料未提供该技能的具体实现形式、依赖环境、收费模式或平台限制,这些信息暂未提供。

黄金标准目录树

/ ├── .config/ # 工具配置(eslint、prettier、dockerfile) ├── .github/ # 工作流、ISSUE_TEMPLATE、CODEOWNERS ├── docs/ # ADR、资源、API 规范 ├── src/ # 源代码 ├── tests/ # E2E / 集成测试 ├── tools/ # 构建脚本 ├── LICENSE └── README.md