From 8dc3304eca5678a252c3aff6f3593aa7f60538b6 Mon Sep 17 00:00:00 2001 From: Tu Shaokun <2801884530@qq.com> Date: Sat, 29 Nov 2025 13:48:01 +0800 Subject: [PATCH] =?UTF-8?q?fix:=20=E7=AC=A6=E5=90=88=E5=AE=98=E6=96=B9=20S?= =?UTF-8?q?kill=20=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - description 改为第三人称 - 目录重命名 references → reference（官方规范） - 文件引用改用 Markdown 链接格式 - 更新 README.md 路径 --- README.md | 24 ++++++++--------- SKILL.md | 27 ++++++++++--------- .../code-review-best-practices.md | 0 .../common-bugs-checklist.md | 0 {references => reference}/python.md | 0 {references => reference}/react.md | 0 {references => reference}/rust.md | 0 .../security-review-guide.md | 0 {references => reference}/typescript.md | 0 {references => reference}/vue.md | 0 10 files changed, 26 insertions(+), 25 deletions(-) rename {references => reference}/code-review-best-practices.md (100%) rename {references => reference}/common-bugs-checklist.md (100%) rename {references => reference}/python.md (100%) rename {references => reference}/react.md (100%) rename {references => reference}/rust.md (100%) rename {references => reference}/security-review-guide.md (100%) rename {references => reference}/typescript.md (100%) rename {references => reference}/vue.md (100%) diff --git a/README.md b/README.md index 25a397f..6b1c15d 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ This is a Claude Code skill designed to help developers conduct effective code r | File | Lines | Description | |------|-------|-------------| | **SKILL.md** | ~180 | Core principles + index (loads on skill activation) | -| **references/react.md** | ~650 | React/Next.js patterns (on-demand) | -| **references/vue.md** | ~200 | Vue 3 patterns (on-demand) | -| **references/rust.md** | ~200 | Rust patterns (on-demand) | -| **references/typescript.md** | ~100 | TypeScript/JS patterns (on-demand) | -| **references/python.md** | ~60 | Python patterns (on-demand) | +| **reference/react.md** | ~650 | React/Next.js patterns (on-demand) | +| **reference/vue.md** | ~200 | Vue 3 patterns (on-demand) | +| **reference/rust.md** | ~200 | Rust patterns (on-demand) | +| **reference/typescript.md** | ~100 | TypeScript/JS patterns (on-demand) | +| **reference/python.md** | ~60 | Python patterns (on-demand) | **Total: ~2,000+ lines** of review guidelines and code examples, loaded on-demand per language. @@ -84,7 +84,7 @@ ai-code-review-guide/ ├── README.md # This file ├── LICENSE # MIT License ├── CONTRIBUTING.md # Contribution guidelines -├── references/ +├── reference/ # On-demand loaded guides │ ├── react.md # React/Next.js patterns (on-demand) │ ├── vue.md # Vue 3 patterns (on-demand) │ ├── rust.md # Rust patterns (on-demand) @@ -197,11 +197,11 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file | 文件 | 行数 | 描述 | |------|------|------| | **SKILL.md** | ~180 | 核心原则 + 索引（技能激活时加载）| -| **references/react.md** | ~650 | React/Next.js 模式（按需加载）| -| **references/vue.md** | ~200 | Vue 3 模式（按需加载）| -| **references/rust.md** | ~200 | Rust 模式（按需加载）| -| **references/typescript.md** | ~100 | TypeScript/JS 模式（按需加载）| -| **references/python.md** | ~60 | Python 模式（按需加载）| +| **reference/react.md** | ~650 | React/Next.js 模式（按需加载）| +| **reference/vue.md** | ~200 | Vue 3 模式（按需加载）| +| **reference/rust.md** | ~200 | Rust 模式（按需加载）| +| **reference/typescript.md** | ~100 | TypeScript/JS 模式（按需加载）| +| **reference/python.md** | ~60 | Python 模式（按需加载）| **总计：2,000+ 行**审查指南和代码示例，按语言按需加载。 @@ -244,7 +244,7 @@ ai-code-review-guide/ ├── README.md # 本文件 ├── LICENSE # MIT 许可证 ├── CONTRIBUTING.md # 贡献指南 -├── references/ +├── reference/ # 按需加载的指南 │ ├── react.md # React/Next.js 模式（按需加载） │ ├── vue.md # Vue 3 模式（按需加载） │ ├── rust.md # Rust 模式（按需加载） diff --git a/SKILL.md b/SKILL.md index 730b8e8..b317217 100644 --- a/SKILL.md +++ b/SKILL.md @@ -1,9 +1,10 @@ --- name: code-review-excellence description: | - Master effective code review practices to provide constructive feedback, catch bugs early, and foster knowledge sharing while maintaining team morale. Use when reviewing pull requests, establishing review standards, or mentoring developers. - Supports: React 19, Vue 3, Rust, TypeScript, Python. - Triggers: "review", "PR", "pull request", "code review" + Provides comprehensive code review guidance for React 19, Vue 3, Rust, TypeScript, and Python. + Helps catch bugs, improve code quality, and give constructive feedback. + Use when reviewing pull requests, conducting PR reviews, establishing review standards, + or mentoring developers through code reviews. --- # Code Review Excellence @@ -162,16 +163,16 @@ Use labels to indicate priority: | Language/Framework | Reference File | Key Topics | |-------------------|----------------|------------| -| **React** | `references/react.md` | Hooks, useEffect, React 19 Actions, RSC, Suspense, TanStack Query v5 | -| **Vue 3** | `references/vue.md` | Composition API, 响应性系统, Props/Emits, Watchers, Composables | -| **Rust** | `references/rust.md` | 所有权/借用, Unsafe 审查, 异步代码, 错误处理 | -| **TypeScript** | `references/typescript.md` | 类型安全, async/await, 不可变性 | -| **Python** | `references/python.md` | 可变默认参数, 异常处理, 类属性 | +| **React** | [React Guide](reference/react.md) | Hooks, useEffect, React 19 Actions, RSC, Suspense, TanStack Query v5 | +| **Vue 3** | [Vue Guide](reference/vue.md) | Composition API, 响应性系统, Props/Emits, Watchers, Composables | +| **Rust** | [Rust Guide](reference/rust.md) | 所有权/借用, Unsafe 审查, 异步代码, 错误处理 | +| **TypeScript** | [TypeScript Guide](reference/typescript.md) | 类型安全, async/await, 不可变性 | +| **Python** | [Python Guide](reference/python.md) | 可变默认参数, 异常处理, 类属性 | ## Additional Resources -- `references/common-bugs-checklist.md` - 按语言分类的常见错误清单 -- `references/security-review-guide.md` - 安全审查指南 -- `references/code-review-best-practices.md` - 代码审查最佳实践 -- `assets/pr-review-template.md` - PR 审查评论模板 -- `assets/review-checklist.md` - 快速参考清单 +- [Common Bugs Checklist](reference/common-bugs-checklist.md) - 按语言分类的常见错误清单 +- [Security Review Guide](reference/security-review-guide.md) - 安全审查指南 +- [Code Review Best Practices](reference/code-review-best-practices.md) - 代码审查最佳实践 +- [PR Review Template](assets/pr-review-template.md) - PR 审查评论模板 +- [Review Checklist](assets/review-checklist.md) - 快速参考清单 diff --git a/references/code-review-best-practices.md b/reference/code-review-best-practices.md similarity index 100% rename from references/code-review-best-practices.md rename to reference/code-review-best-practices.md diff --git a/references/common-bugs-checklist.md b/reference/common-bugs-checklist.md similarity index 100% rename from references/common-bugs-checklist.md rename to reference/common-bugs-checklist.md diff --git a/references/python.md b/reference/python.md similarity index 100% rename from references/python.md rename to reference/python.md diff --git a/references/react.md b/reference/react.md similarity index 100% rename from references/react.md rename to reference/react.md diff --git a/references/rust.md b/reference/rust.md similarity index 100% rename from references/rust.md rename to reference/rust.md diff --git a/references/security-review-guide.md b/reference/security-review-guide.md similarity index 100% rename from references/security-review-guide.md rename to reference/security-review-guide.md diff --git a/references/typescript.md b/reference/typescript.md similarity index 100% rename from references/typescript.md rename to reference/typescript.md diff --git a/references/vue.md b/reference/vue.md similarity index 100% rename from references/vue.md rename to reference/vue.md