Skip to content

ONEISALL7/ai-devtools-cn

AI DevTools CN

Markdown Check CI Latest Release npm version License: MIT

面向中文开发者的 AI 开发工具实践模板库,收集可复用的工作流、提示词模板、代码审查模板、issue 分流模板、发布说明模板和工具评估清单。

这个项目的目标不是追逐工具榜单,而是帮助开发者把 AI 工具稳定地接入真实工程流程:需求澄清、代码生成、PR review、测试补全、文档维护、CI 排错和 release 管理。

项目适合谁

  • 正在使用 AI 编程工具的个人开发者
  • 需要建立团队 AI 工程规范的技术负责人
  • 维护开源项目、需要降低 triage/review/docs 负担的 maintainer
  • 想系统整理 AI 工具实践经验的中文技术社区成员

仓库内容

docs/        中文实践文档
templates/   可复制的提示词和维护模板
examples/    示例工作流
.github/     issue、PR 和 CI 配置

快速开始

第一次使用建议从 3 分钟快速上手 开始。

如果你不知道该选哪个模板,先看 如何选择模板

最短路径一:直接复制模板

  1. 按场景从下面选择一个模板。
  2. 复制模板内容到你的 AI 开发工具。
  3. 替换项目背景、技术栈、约束条件和期望输出。
  4. 把有效结果沉淀到 issue、PR、文档或 release note。

最短路径二:用 npm CLI 或仓库内 CLI 生成工作稿

运行 npx 前必须先确认 npm 当前已发布版本:

npm view ai-devtools-cn version

如果 npm view 返回的版本低于 README 中的最新 release,说明 npm 包还没有同步到 GitHub main 的最新 CLI;请先 clone 仓库使用对应的 npm run templates:* 命令,或等待下一次 npm 发布。

如果 npm 公开包落后,推荐先用源码路径:

git clone https://github.com/ONEISALL7/ai-devtools-cn.git
cd ai-devtools-cn
npm install
npm run templates:doctor
npm run templates:launch
npm run templates:recipes -- ci-failure
npm run templates:pilot -- ci-failure --output work/pilot-ci
npm run templates:contribute

当 npm 版本已经同步到 0.18.3 或更高时,可以无需克隆仓库直接运行:

npx ai-devtools-cn doctor
npx ai-devtools-cn launch
npx ai-devtools-cn recipes
npx ai-devtools-cn recipes ci-failure
npx ai-devtools-cn pilot ci-failure --output work/pilot-ci
npx ai-devtools-cn pilot-invite --output work/pilot-invites.md
npx ai-devtools-cn contribute
npx ai-devtools-cn handoff
npx ai-devtools-cn handoff --issue 45 --output work/handoff-45.md
npx ai-devtools-cn pr-pack 45 --output work/pr-pack-45.md
npx ai-devtools-cn review-pr --pr 123 --author external-dev --issue 45 --output work/review-pr-123.md
npx ai-devtools-cn claim 45 --output work/claim-45.md
npx ai-devtools-cn starter 45 --output work/node-ci-starter.md
npx ai-devtools-cn recommend ci
npx ai-devtools-cn trial --template pr-review --output work/trial
npx ai-devtools-cn adoption --template pr-review --output work/adoption-sprint
 npx ai-devtools-cn readiness --output work/openai-readiness-YYYY-MM-DD.md
npx ai-devtools-cn publish-status

如果你在本仓库内开发或贡献,再使用 npm scripts:

npm install
npm run templates:list
npm run templates:examples
npm run templates:recipes
npm run templates:recipes -- ci-failure
npm run templates:launch
npm run templates:contribute
npm run templates:handoff
npm run templates:pr-pack -- 45 --output work/pr-pack-45.md
npm run templates:review-pr -- --pr 123 --author external-dev --issue 45 --output work/review-pr-123.md
npm run templates:claim -- 45 --output work/claim-45.md
npm run templates:starter -- 45 --output work/node-ci-starter.md
npm run templates:recommend -- ci
npm run templates:validate
npm run templates:doctor
npm run templates:publish-check
npm run templates:trial -- --template pr-review --output work/trial
npm run templates:new -- ci-troubleshooting --output work/ci-debug.md
npm run templates:kit -- oss-maintainer --output work/oss-maintainer-kit
npm run templates:feedback -- --template pr-review --output work/feedback.md
npm run templates:outreach -- --template pr-review --channel x --output work/outreach.md
npm run templates:adoption -- --template pr-review --output work/adoption-sprint
npm run templates:publish-status
npm run templates:evidence -- --output work/external-evidence.md
npm run templates:readiness -- --output work/openai-readiness-YYYY-MM-DD.md

本仓库当前 CLI 命令:

npx ai-devtools-cn list
npx ai-devtools-cn examples
npx ai-devtools-cn recipes
npx ai-devtools-cn recipes pr-review-docs
npx ai-devtools-cn launch
npx ai-devtools-cn pilot-invite --output work/pilot-invites.md
npx ai-devtools-cn contribute
npx ai-devtools-cn handoff --output work/external-pr-handoff.md
npx ai-devtools-cn handoff --issue 45 --output work/handoff-45.md
npx ai-devtools-cn pr-pack 45 --output work/pr-pack-45.md
npx ai-devtools-cn review-pr --pr 123 --author external-dev --issue 45 --output work/review-pr-123.md
npx ai-devtools-cn claim 45 --output work/claim-45.md
npx ai-devtools-cn starter 45 --output work/node-ci-starter.md
npx ai-devtools-cn recommend ci
npx ai-devtools-cn doctor
npx ai-devtools-cn publish-check
npx ai-devtools-cn trial --template pr-review --output work/trial
npx ai-devtools-cn new pr-review --output work/pr-review.md
npx ai-devtools-cn outreach --template pr-review --channel x --output work/outreach.md
npx ai-devtools-cn adoption --template pr-review --output work/adoption-sprint
npx ai-devtools-cn evidence --output work/external-evidence.md
npx ai-devtools-cn readiness --output work/openai-readiness-YYYY-MM-DD.md
npx ai-devtools-cn publish-status

更多命令见 模板 CLI

CLI 生成的相对路径会写入你运行命令时所在的当前目录,适合在自己的项目里生成 work/ 草稿。

第一次外部 PR

如果你想提交第一个小 PR,可以从下面这些 good first issue 开始:

Issue 任务 建议 PR 标题
#45 Node.js CI 排错示例 Add Node.js CI troubleshooting case study
#46 依赖升级风险示例 Add dependency upgrade risk example
#47 用户反馈案例整理文档 Add user feedback case documentation guide
#48 Python 项目 PR review 示例 Add Python PR review example
#49 前端 README 改进示例 Add frontend README improvement example

建议流程:

  1. 在对应 issue 下留言说明你想认领。
  2. Fork 仓库到自己的 GitHub 账号。
  3. Clone 仓库并安装依赖。
  4. 以 #45 为例,生成本地草稿:
git clone https://github.com/ONEISALL7/ai-devtools-cn.git
cd ai-devtools-cn
npm install
npm run templates:contribute
npm run templates:handoff -- --issue 45 --output work/handoff-45.md
npm run templates:pr-pack -- 45 --output work/pr-pack-45.md
npm run templates:claim -- 45 --output work/claim-45.md
npm run templates:starter -- 45 --output work/starter-45.md

等 npm 版本同步到 0.18.3 或更高后,也可以改用:

npx ai-devtools-cn handoff --issue 45 --output work/handoff-45.md
npx ai-devtools-cn pr-pack 45 --output work/pr-pack-45.md
npx ai-devtools-cn claim 45 --output work/claim-45.md
npx ai-devtools-cn starter 45 --output work/starter-45.md

这些本地草稿只帮助你准备 PR。只有外部贡献者用自己的 GitHub 账号提交并合并的 PR,才可能被记录为 external merged PR。

按身份开始

你是谁 第一步
第一次试用的外部用户 外部试用者快速指南,完成一次 10-15 分钟试用
想直接照着做一个场景的用户 真实试用配方,选择 pr-review-docsci-failureissue-triagerelease-note
想邀请一个外部用户试用 运行 npx ai-devtools-cn pilot ci-failure --output work/pilot-ci,把生成的 tester-task.md 发给对方
想同时邀请 2-3 个真实外部试用者 运行 npx ai-devtools-cn pilot-invite --output work/pilot-invites.md,复制里面的一对一邀请、公开渠道文案和跟进表
个人开发者 PR Review 模板 检查一次改动
开源维护者 Issue Triage 模板 分流一个 issue
想邀请外部贡献者的维护者 外部贡献者引导模板 写清楚第一个 PR
正在修 CI 的维护者 CI 排错模板 分析失败日志
技术负责人 AI 工具导入检查清单 设计团队试点规则
发版负责人 发布说明模板 生成 release note 草稿

外部真实案例清单

模板索引

完整说明见 模板目录

场景 直接复制
PR review PR Review 模板
issue 分流 Issue Triage 模板
CI 排错 CI 排错模板
测试补全 测试生成模板
文档维护 文档更新模板
README 改进 README 改进模板
release note 发布说明模板
依赖升级评估 依赖升级风险模板
安全审查 安全审查模板
公开前脱敏 公开安全脱敏模板
工具选型 工具评估清单
团队导入 AI 工具导入检查清单
输出验收 AI 输出质量评估模板
外部贡献者引导 外部贡献者引导模板

示例

完整说明见 示例目录

场景 示例
PR review PR Review 示例
issue 分流 Issue Triage 示例
CI 排错 CI 排错示例
release note Release note 示例
第一批用户试用 PR Review 文档改动试用包
Node.js CI 试用 Node.js CI 排错试用包
Python pytest 试用 Python pytest 失败试用包
pnpm workspace CI 试用 pnpm workspace CI 排错试用包

真实维护案例

这些案例基于本仓库真实 issue、PR、CI 和 release 记录整理,适合照着复制到自己的项目中:

更多“用户一次就能复现”的实用路径见:

文档入口

设计原则

  • 工程优先:模板必须能用于真实项目,不收录只有演示价值的提示词。
  • 可复现:每个模板尽量包含输入、约束、输出格式和验收标准。
  • 可维护:文档需要标注适用范围,避免把阶段性经验写成永久结论。
  • 中文友好:默认用中文解释概念,同时保留必要英文术语。
  • 工具中立:不绑定单一产品,除非文档明确说明适用工具和版本。

贡献方式

欢迎提交以下内容:

  • 新的 AI 工程工作流模板
  • 真实项目中的使用案例
  • 对现有模板的修订和边界条件补充
  • 文档错别字、过期信息或链接修复
  • 面向特定技术栈的模板,例如 Python、Node.js、Rust、前端、数据工程等

开始前请阅读 CONTRIBUTING.md。如果你想认领一个小任务,可以从 Good First IssuesGood First PR Briefs外部 PR 交接包 开始。

如果你已经使用过某个模板或 CLI,请阅读 用户反馈,并通过 issue 反馈真实使用场景。反馈可以匿名化,不需要公开私有代码或敏感日志。

维护路线

当前优先级:

  • 建立核心模板库
  • 补充真实使用案例
  • 增加工具评估维度
  • 建立 issue/PR 分流机制
  • 发布稳定版本

详细计划见 ROADMAP.md

许可协议

本项目使用 MIT License

About

中文 AI 开发者工具实践模板库:PR review、issue triage、测试生成、文档维护、release 和工具评估工作流。

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors