feat: add AI code review documentation, demonstration project, and update guidelines
This commit is contained in:
@@ -0,0 +1,66 @@
|
||||
# Prompt Cheat-Sheet (copy-paste khi demo)
|
||||
|
||||
Dùng được cho mọi tool (Claude Code, Cursor, Codex, ChatGPT...). Mở sẵn file này, demo chỉ việc copy.
|
||||
|
||||
---
|
||||
|
||||
## ① BEFORE — cách làm sai (sẽ bỏ lọt lỗi business)
|
||||
|
||||
> Dán **cả file** `orderService.js` (bản đã thêm code mới), prompt mơ hồ, KHÔNG kèm CLAUDE.md, KHÔNG nói ý định:
|
||||
|
||||
```
|
||||
Review giúp tôi file orderService.js này xem có vấn đề gì không:
|
||||
|
||||
<dán toàn bộ nội dung orderService.js vào đây>
|
||||
```
|
||||
|
||||
Kết quả điển hình: vài góp ý chung chung (thêm try/catch, kiểm tra null, đặt tên...) và **bỏ lọt** lỗi cancel đơn đã shipped.
|
||||
|
||||
---
|
||||
|
||||
## ② AFTER — đúng phương pháp (bắt đúng lỗi business)
|
||||
|
||||
> Kèm **CLAUDE.md**, chỉ đưa **diff**, nói rõ **ý định**, ép **lọc false positive**:
|
||||
|
||||
```
|
||||
Bạn review CHỈ phần code MỚI THÊM (diff) dưới đây.
|
||||
Mục tiêu của PR: thêm tính năng hủy đơn hàng (cancel order).
|
||||
Đối chiếu với rule trong CLAUDE.md (đính kèm).
|
||||
Chỉ báo lỗi bạn CHẮC CHẮN, kèm dòng code + lý do (trích rule nếu vi phạm).
|
||||
Bỏ qua nitpick và lỗi linter tự bắt.
|
||||
|
||||
--- CLAUDE.md ---
|
||||
<dán nội dung CLAUDE.md>
|
||||
|
||||
--- DIFF ---
|
||||
<dán phần diff trong PR-diff.md>
|
||||
```
|
||||
|
||||
Kết quả mong đợi: bắt đúng **lỗi cancel đơn shipped** (trích rule) + chỉ ra **toMoney trùng formatCurrency**, bỏ hết nitpick.
|
||||
|
||||
---
|
||||
|
||||
## ③ PERSONA AGENTS — chia vai để đào sâu (tùy chọn, ấn tượng)
|
||||
|
||||
Chạy 2 lượt riêng, mỗi lượt một vai (hoặc tạo subagent trong `.claude/agents/`):
|
||||
|
||||
**Business-logic agent:**
|
||||
```
|
||||
Bạn là reviewer chuyên về BUSINESS LOGIC.
|
||||
Đối chiếu diff dưới đây với phần "Business rules" trong CLAUDE.md.
|
||||
Chỉ ra mọi chỗ code đi ngược rule, kèm trích dẫn rule.
|
||||
<đính kèm CLAUDE.md + diff>
|
||||
```
|
||||
|
||||
**Maintainability agent:**
|
||||
```
|
||||
Bạn là reviewer chuyên về MAINTAINABILITY.
|
||||
Kiểm tra code mới có viết trùng hàm/util đã tồn tại trong repo không
|
||||
(gợi ý: xem src/lib/format.js). Đề xuất tái sử dụng.
|
||||
<đính kèm diff + nội dung src/lib/format.js>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ④ (Tùy chọn) Claude Code /code-review trên PR thật
|
||||
Nếu muốn demo lệnh native: chạy `setup.sh` để tạo branch + diff, push lên GitHub tạo PR, rồi chạy `/code-review`.
|
||||
Reference in New Issue
Block a user