55 Commits
Author SHA1 Message Date
Daniel Liu 4850184dfd chore: ignore install artifacts and clean SKILL.md frontmatter (#30)
- .gitignore: ignore skills-lock.json and .skills.json produced by npx skills add
- SKILL.md: drop inline comments on allowed-tools (valid YAML cleanup)
- README: use 'npx skills add' without --skill (root SKILL.md is auto-discovered)

Rebased onto current main; the Dart/Flutter guide from #31 is preserved.
2026-09-08 23:09:45 +08:00
tt-a1iandtt-a1i 277f479301 feat: add Dart/Flutter review guide and npx skills docs (#31)
Give Flutter/Dart PRs a dedicated review guide, and document
`npx skills add` while keeping SKILL.md at the repo root so
clone-into-~/.claude/skills still works.

Co-authored-by: tt-a1i <tt-a1i@users.noreply.github.com>
2026-08-23 22:29:31 +08:00
tt-a1i 95c707b999 Merge pull request #26 from smf-h/feat/add-ruby-rails-guide
feat: add Ruby and Rails code review guide
2026-07-16 14:13:07 +08:00
tt-a1i 6a75102283 docs: polish Ruby guide session, Active Storage, and migration notes
Split Active Storage/SSRF into its own section, clarify session_store
belongs in an initializer, and note null: false backfill for existing
tables.
2026-07-16 14:12:54 +08:00
smf-h 72c25a683c docs: update Ruby guide line count 2026-07-16 13:56:48 +08:00
smf-h 4294566502 docs: expand Ruby quick review checklist 2026-07-16 13:53:56 +08:00
smf-h 21bf90d22c docs: address Ruby and Rails review feedback
Updated Ruby security guidelines for deserialization, error handling, and parameter handling. Improved clarity on using safe YAML loading, idempotency keys, and CSRF protection.
2026-07-16 13:51:26 +08:00
smf-h ee03536324 feat: add Ruby and Rails code review guide 2026-07-14 11:43:11 +08:00
f2fd4e57d9 feat: add Java 8 / Spring Boot 2 legacy review guide (#24)
* feat: add Java 8 / Spring Boot 2 legacy review guide

Support reviewing long-lived Java 8 and Boot 2 (javax.*) codebases without
forcing Java 17/21 patterns. Closes #23.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs: rewrite Java 8 legacy guide in English

Make the guide accessible to international contributors; keep examples
and review checklists in English like other language guides (e.g. php.md).

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: tt-a1i <tt-a1i@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-09 14:50:14 +08:00
tt-a1iandtt-a1i 28e918267d docs: expand review guides and sync release metadata (#21)
Co-authored-by: tt-a1i <tt-a1i@users.noreply.github.com>
2026-06-28 17:16:10 +08:00
ljymillerand李嘉扬 1c8968729d feat: add Zig code review guide (#18)
* feat: add Zig code review guide

* fix: address Zig guide review feedback

* fix: address final Zig guide review notes

---------

Co-authored-by: 李嘉扬 <miller@lijiayangdeMacBook-Pro.local>
2026-06-25 14:27:01 +08:00
tt-a1i 17267ff26b fix: correct review-guide errors and sync skill metadata (#16)
Correctness fixes in the reference guides:
- django: len()/count() caching explanation was reversed; fix slicing/index
  cache example; replace nonexistent __acall__ async middleware with the
  documented markcoroutinefunction pattern; drop removed
  SECURE_BROWSER_XSS_FILTER; REFERRER_POLICY -> SECURE_REFERRER_POLICY
- security: path-traversal guard compared a relative path to an absolute one
  (rejected every valid file); compare absolute-vs-absolute
- nestjs: e2e ValidationPipe needs forbidNonWhitelisted/transform for the
  "extra field -> 400" test to pass
- rust: select! cancel-safety example used read on both sides; bad case now
  uses non-cancel-safe read_exact
- code-quality: "read less" example still read the whole file; use readline()
- svelte: drop nonexistent unstate() (use $state.snapshot); fix devalue/Date
  note; comma-operator each-key -> template literal
- c/cpp/qt: restore mangled markers that rendered as a literal ?
- csharp: drop fabricated perf numbers
- java: scope HashMap infinite-loop note to Java 7 and earlier
- kotlin: closeableScope -> built-in viewModelScope
- css: deprecated darken()/clip:rect() -> color.adjust/clip-path
- typescript: legacy .eslintrc -> flat config (typescript-eslint v8)

Tooling and metadata:
- pr-analyzer.py: filename regex corrupted lib//web//db/ paths; parse the diff
  header via backreference and add utf-8/error handling; add test
- SKILL.md: canonical name code-review-skill; document severity tiers; wire in
  pr-analyzer.py
- README/CONTRIBUTING: fix stale skill name and line counts; complete the guide
  tree; add a conventions section
2026-06-05 09:45:40 +08:00
Fernando BassandTu Shaokun ca6a249dbb Add Swift code review guide (#15)
* Add Swift code review guide

Add reference/swift.md covering modern Swift (5.9+/6): optionals and
safe unwrapping, value vs reference types, Swift Concurrency and data
race safety, SwiftUI property wrappers, and the API Design Guidelines.

Register the guide across the docs: language tables and file trees in
README.md (EN and zh), the SKILL.md description and guide table, the
common bugs checklist, and both landing pages. Bump the language count
from 19+ to 20+.

* fix: refine Swift guide examples

---------

Co-authored-by: Tu Shaokun <2801884530@qq.com>
2026-06-05 09:43:08 +08:00
tt-a1i 65079305d9 Add PHP review guide (#14)
* Add PHP review guide

* Translate PHP guide to English and correct line-count stats

Rewrite reference/php.md in English to match the FastAPI guide's
convention, since most users read English. Also fix the line-count
badge/blurb from 17,000+ to 16,000+ to match the actual total (~16.9k).
2026-05-30 16:12:25 +08:00
Tu Shaokun 39a9698c31 docs: bump language count to 18+ and add References to FastAPI TOC
Follow-up to #12: the badge was bumped to 18+ but the EN/ZH prose
still read 17+, and the FastAPI guide TOC was missing its References
entry.
2026-05-29 23:25:32 +08:00
tt-a1i 3d11212d05 Merge pull request #12 from Momoyeyu/feat/fastapi-guide
feat: add FastAPI code review guide
2026-05-29 23:24:45 +08:00
Momoyeyu e4c56a0396 docs: clarify why tests anchor a coding agent's review 2026-05-29 18:10:40 +08:00
Momoyeyu 0f3f613232 feat: add FastAPI code review guide 2026-05-29 18:04:32 +08:00
tt-a1i aca7203b42 feat: add man-page styled landing page for GitHub Pages
Adds index.html (zh_CN) and index.en.html (en_US) — a man(1)-style
landing page rendered in IBM Plex Mono on a warm amber-on-dark palette,
with ASCII title, vim-like status bar, and j/k/g/G/q keyboard nav.

Includes .nojekyll so GitHub Pages serves the HTML as-is.
2026-05-26 09:14:47 +08:00
tt-a1i eb12fb247b Merge pull request #11 from xronocode/feat/add-universal-quality-guide
feat: Add universal quality anti-patterns guide + low-level efficiency patterns
2026-05-09 13:53:18 +08:00
xronocodeandClaude Opus 4.7 52d6a14cd3 fix: address review feedback on universal quality + perf guides
- code-quality-universal.md: drop broken TS lookup-table example whose
  one-key {key:true} object always evaluated to `true`; promote the
  bgMap variant to the single ✅ block
- code-quality-universal.md: rename `## Review Checklist` to
  `## 通用质量审查清单` (and TOC anchor) for consistency with peer
  reference files that close with a Chinese checklist heading
- performance-review-guide.md: move `## 低级别效率反模式` above
  `## 参考资源` so the references section remains the file's terminal
  section, matching every other reference file
- performance-review-guide.md: slim `## 低级别效率反模式` from heavy
  ❌/✅ examples to a checklist with two illustrative snippets, and
  cross-link the resource-management overlap into
  common-bugs-checklist.md#resource-management

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-09 11:31:08 +06:00
xronocode 836d467978 feat. (feat) Add universal quality anti-patterns guide + low-level efficiency patterns
New guide: reference/code-quality-universal.md (~320 lines)
- Code reuse audit: search existing utilities before accepting new code
- Parameter sprawl: options object / dataclass instead of 4+ params
- Leaky abstractions: hide ORM/HTTP/file format internals
- Stringly-typed code: use enum/constant/union type over raw strings
- Nested conditionals: flatten ternary chains and nested if/else
- Copy-paste variants: unify near-duplicate code with shared abstraction
- No-op updates: add change-detection guards to polling/intervals
- TOCTOU: replace check-then-act with try-act-catch
- Overly broad operations: push filtering to DB/storage layer
- Redundant state: derive values instead of storing duplicates

Updated SKILL.md Phase 3 with Reuse Check dimension + cross-cutting guide table.
Extended performance-review-guide.md with low-level efficiency patterns:
unnecessary work, missed concurrency, hot-path bloat, unbounded data structures.
Updated README.md bilingual tables, trees, and badges.
2026-05-09 10:50:28 +06:00
tt-a1i c5a33c5b61 Merge pull request #10 from xronocode/feat/add-6-new-guides
feat: Add 6 new framework/language review guides (+4,700 lines)
2026-05-09 11:53:44 +08:00
tt-a1i 113988d9e6 fix: move NestJS to Backend, dedupe Django row, close angular.md table cell 2026-05-09 11:53:21 +08:00
tt-a1i 819b28c8e6 Merge pull request #9 from xronocode/fix/dry-common-bugs-checklist
fix: eliminate DRY violations, fix stale docs, improve pr-analyzer
2026-05-09 11:41:12 +08:00
tt-a1i e569929301 docs: keep collation and timezone items in SQL checklist 2026-05-09 11:40:38 +08:00
xronocode 139e6b1106 feat. (feat) Add 6 new framework/language review guides: Angular 17+, Svelte 5, NestJS, Django/DRF, Kotlin/Android, C#/.NET 8
- Angular: Signals, Standalone components, RxJS, Zoneless, template optimization
- Svelte/SvelteKit: Runes, Load functions, Form Actions, Store migration, SSR/CSR
- NestJS: DI & layered architecture, Guards/Interceptors/Pipes, DTO validation, circular deps
- Django/DRF: Security audit, N+1 queries, Serializer anti-patterns, async views
- Kotlin/Android: Coroutines, Flow, Jetpack Compose, null safety, memory leaks
- C#/.NET 8: C# 12 features, async, EF Core, ASP.NET Core, LINQ

Update SKILL.md and README.md index tables, badges, and repo trees.
2026-05-08 17:15:31 +06:00
xronocode d367294bac fix: eliminate DRY violations in common-bugs-checklist, fix stale CONTRIBUTING.md, improve pr-analyzer.py
- Refactor common-bugs-checklist.md from 1227 lines to 217 lines:
  replace duplicated code examples with concise checklist items
  linking to the dedicated language-specific guides
- Fix CONTRIBUTING.md: stale directory name (ai-code-review-guide ->
  code-review-skill), missing files (go.md, qt.md, css-less-sass.md,
  architecture-review-guide.md, performance-review-guide.md)
- Fix pr-analyzer.py detect_language(): use os.path.splitext instead of
  fragile .endswith(), add missing extensions (.vue, .kt, .swift, .php,
  .cs, .svelte, .zig, .ex, .scala, .lua)
- Fix pr-analyzer.py generate_suggestions(): replace fragile string
  matching on risk messages with RISK_NO_TESTS constant
2026-05-08 16:09:36 +06:00
Tu Shaokun f4a63c7b32 docs: redesign README with improved visual layout and bilingual structure
- Add shields.io badges (license, Claude Code, lines, languages, PRs welcome)
- Add centered header with bilingual subtitle
- Restructure language support as HTML table with file references and line counts
- Add four-phase review process diagram
- Add severity labels table with color indicators
- Add collapsible language highlight sections
- Improve bilingual (EN/CN) content with consistent structure
- Add usage examples table and installation instructions for all platforms
2026-03-01 17:13:20 +08:00
Tu Shaokun 48e8eb14b2 Merge pull request #7 from xstongxue/qt-skill
Qt skill
2026-02-03 14:09:35 +08:00
xstongxue 036d8abab6 feat: add QT guides and update indexes 2026-02-03 11:42:29 +08:00
龚梦帅 d3102ac0f1 feat: add QT guides and update indexes 2026-01-29 10:23:32 +08:00
Tu Shaokun e3714058dd Merge pull request #4 from seekskyworld/feat/Revise_the_description
feat: add C/C++ guides and update indexes
2026-01-12 10:28:48 +08:00
seekskyworld 3a76efb984 feat: add C/C++ guides and update indexes 2026-01-11 21:00:07 +08:00
Tu Shaokun 626b5e9dd5 Merge pull request #3 from seekskyworld/seekskyworld
feat: add C and C++ code review guides
2026-01-11 18:01:20 +08:00
seeksky c687f500b7 feat: add C and C++ code review guides 2026-01-11 17:54:54 +08:00
Tu Shaokun 25bb415cef Merge pull request #1 from tt-a1i/feat/java-support
Add Java support to code review skill
2025-12-04 23:01:28 +08:00
google-labs-jules[bot] e72fafef25 feat: Add Java 17+ and Spring Boot 3 code review guide
- Create `reference/java.md` with guidelines for modern Java (Records, Switch, Text Blocks), Spring Boot 3 (DI, Configuration), JPA (Performance, N+1), and Concurrency (Virtual Threads).
- Update `SKILL.md` to register the Java guide for on-demand loading.
- Update `README.md` to include Java in supported languages and key topics.
2025-12-04 14:50:08 +00:00
Tu Shaokun 71e1718864 docs: 更新贡献方向列表(移除已支持的 Go) 2025-11-30 18:25:37 +08:00
Tu Shaokun 7a66dab176 feat: 添加 Go 语言代码审查指南
新增 reference/go.md (~990 行),涵盖:
- 错误处理(errors.Is/As, 包装, 自定义错误)
- 并发(goroutine 泄漏, channel, sync.WaitGroup)
- Context 使用(传播, 取消, 超时)
- 接口设计(接受接口返回结构体, 小接口)
- 接收器类型选择(值/指针)
- 性能优化(预分配, sync.Pool, 逃逸分析)
- 测试(表驱动, 并行, Mock)
- 常见陷阱(nil slice, map 初始化, defer 循环)

更新 SKILL.md 和 README.md 添加 Go 语言支持
总行数:~8000 → ~9000 行
2025-11-30 18:15:36 +08:00
Tu Shaokun 2830b9873a feat: 在审查流程中添加架构/性能审查触发点
- Phase 2 添加 Architecture Review Guide 引用
- 新增 Performance Assessment 检查项
- 明确列出关键检查点(SOLID、N+1、复杂度等)
2025-11-30 15:35:08 +08:00
Tu Shaokun 7d5a22c4de docs: 更新 README 与实际内容同步
- 更新仓库名为 code-review-skill
- 添加 CSS/Less/Sass、架构设计、性能优化到支持列表
- 添加 3 个新文件到文件结构
- 更新内容统计(总计 8000 行)
- 同步中英文版本
2025-11-30 15:12:13 +08:00
Tu Shaokun ee5826118a fix: 修复代码示例语法错误
- vue.md: 添加缺失的注释符号 //
- react.md: 添加缺失的 async 关键字
2025-11-30 11:20:26 +08:00
Tu Shaokun 91a79e39a9 feat: 添加性能审查指南
- Core Web Vitals (LCP, INP, CLS, FCP, TBT)
- JavaScript 性能(代码分割、Bundle 优化、虚拟列表)
- 内存管理(泄漏检测、清理模式)
- 数据库性能(N+1、索引、查询优化)
- API 性能(分页、缓存、限流)
- 算法复杂度(Big O、常见优化)
- 性能度量阈值和工具推荐
2025-11-29 21:58:45 +08:00
Tu Shaokun 1479bc3d87 feat: 添加 CSS/Less/Sass 审查指南
- CSS 变量 vs 硬编码规范
- !important 使用规范
- 性能优化(transition: all, box-shadow 动画, reflow)
- 响应式设计检查点(Mobile First, 断点)
- 浏览器兼容性(Autoprefixer, 回退策略)
- Less/Sass 嵌套深度和 Mixin 使用
2025-11-29 21:24:57 +08:00
Tu Shaokun 4838339c08 feat: 添加 Bash 和 WebFetch 到 allowed-tools 2025-11-29 21:20:20 +08:00
Tu Shaokun 50496be98a feat: 添加架构设计审查指南
- 新增 architecture-review-guide.md
- 包含 SOLID 原则检查清单
- 包含架构反模式识别
- 包含耦合度与内聚性评估
- 包含分层架构审查
- 包含设计模式使用评估
- 包含可扩展性评估
- 更新 SKILL.md 添加新指南引用
2025-11-29 17:38:42 +08:00
Tu Shaokun 8f4e8f2f35 feat: 增强 frontmatter 配置
- 添加 allowed-tools (Read, Grep, Glob)
- 扩展 description 触发词,提高自动发现率
2025-11-29 14:35:35 +08:00
Tu Shaokun aa426d1588 fix: 修复 SKILL.md 文件引用格式
- 将反引号格式改为 Markdown 链接格式
- 修复路径拼写错误 references → reference
2025-11-29 14:16:43 +08:00
Tu Shaokun 98e458099b docs: 更新贡献指南,添加 Claude Code Skill 开发规范
新增内容:
- Frontmatter 规范(name、description、allowed-tools)
- 命名约定(kebab-case、64字符限制)
- Description 写法规范(功能陈述 + Use when 触发条件)
- Progressive Disclosure 原则和文件职责划分
- 文件引用规范(Markdown 链接格式)
- Skill 设计原则(单一职责、版本管理、内容质量)
- 常见问题解答
2025-11-29 14:12:23 +08:00