Community生产力与协作github.com

Luijaa/web-template

在打开或更新 Pull Request 之前,运行完整的预 PR 检查清单(make check、密钥扫描、文档、差异审查)。请在创建 PR 或被问及工作是否准备好时使用。

web-template 是什么?

该技能提供了一个全面的预 Pull Request 检查清单,旨在帮助开发者在提交或更新 PR 之前确保代码质量、安全性和文档完整性。它支持 Claude Code、Cursor、Codex 等 AI 编码代理,通过在 PR 创建或更新时自动执行检查流程,减少人工审查的工作量。技能的核心是执行一个包含 12 个步骤的严格检查,涵盖构建验证 (`make check`)、敏感信息扫描、依赖管理、数据库迁移、文档同步、UI 一致性检查以及提交信息规范。该技能会生成一个“通过/不通过”的表格报告,并附上证据(命令和结果摘要),确保只有完全符合团队要求的代码变更才能进入 PR 阶段。任何检查项失败都会阻止 PR 的创建,并提示开发者修复问题或报告阻塞项。

兼容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Luijaa/web-template/tree/HEAD/.agents/skills/pre-pr-check

Installed? Explore more 生产力与协作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

预 PR 检查

执行所有步骤,并以表格报告 通过/不通过,附带证据(命令和结果摘要)。

  1. make check 必须全部通过(docs-check, lint + SAST, test, build, license)— 除以下 2 种情况:

    • 纯文档 PR(docs(design): …, ADR, docs):只需 make docs-check 通过即可
    • 尚未选定技术栈的仓库(target 显示 not configured — ADR-0001 尚未 accepted):该 target 报告为 N/A(尚未设置),不算通过,也不构成阻止原因 — 禁止修改 recipe 为 exit 0 以使其通过

    如果更改了用户可见内容(需要新增/修改 e2e 测试),还需执行 make e2e;如果触及中间件、header、cookie、错误页面或新路由,还需执行 make dast

  2. git diff origin/main...HEAD --stat — 确认只修改了工作相关的文件,无多余文件(构建输出、.env、个人文件)

  3. 检查是否遗留了临时日志:git diff origin/main...HEAD | grep -n '\[DBG-' 必须无结果(fix-bug 第 3 条)

  4. 在 diff 中搜索密钥:git diff origin/main...HEAD | grep -nEi '(api[_-]?key|secret|token|password|BEGIN .*PRIVATE KEY)' — 若发现则停止并报告

  5. 新增的环境变量必须全部出现在 .env.example 中

  6. 新增/升级的依赖项(查看 lockfile、go.mod、Dockerfile FROM 的 diff):版本和许可证必须符合 docs/dependencies.md,并在 PR 描述中注明

  7. 新的数据库迁移(如有):必须可执行且可回滚

  8. 文档:README/docs/ADR(docs/adr/)需根据变更内容更新;领域新词需放入 CONTEXT.md,且代码中的名称与 CONTEXT.md 保持一致

  9. 按 review 技能进行审查(Claude Code:子代理 reviewer;其他代理:读取 .agents/skills/review/SKILL.md 并自审 diff),并修复所有“必须修改”的问题

  10. 提交信息格式为 Conventional Commits,且分支名不是 main

  11. PR 描述包含 Closes #<issue>(若无 issue 则先创建),以及标题 ## CHANGELOG(分类 + 一行面向用户的泰语描述,或 -)— 不要自行编辑 CHANGELOG.md(参见 docs/release.md)

  12. 若涉及 UI:无硬编码文本、所有语言键齐全、无直接颜色值、检查 th/en × light/dark 两种模式(参见 docs/ui.md)

若任何一项不通过,请勿创建 PR,应先修复问题或报告阻塞项。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

相关技能