Mục lục
Giới Thiệu Repository Agent Rules
Agent Rules là một kho lưu trữ GitHub công khai chứa bộ sưu tập các quy tắc có thể tái sử dụng và tài liệu kiến thức dành cho các trợ lý lập trình AI hiện đại như Claude Code và Cursor. Repository này được thiết kế để giúp các nhà phát triển tận dụng tối đa sức mạnh của AI trong quá trình viết code.
Cấu Trúc Thư Mục Chi Tiết
📁 project-rules/ – Bộ Quy Tắc Dự Án
Chứa các quy tắc có thể hành động ngay lập tức cho AI:
- Quy Trình Phát Triển: Các bước từ commit code cho đến review pull request
- Chất Lượng Code: Kiểm tra định dạng, phân tích đa ngôn ngữ
- Giải Quyết Vấn Đề: Phân tích lỗi, kỹ thuật 5 Whys
- Tài Liệu Hóa: Tự động tạo docs và biểu đồ Mermaid
- Thiết Lập Dự Án: Cách đặt ngữ cảnh và cải thiện liên tục
📁 docs/ – Tài Liệu Tham Khảo
Bao gồm các hướng dẫn chuyên sâu về:
- Phát triển Swift: Observable macro, Testing framework
- Model Context Protocol (MCP): Best practices, releasing package
📁 global-rules/ – Cấu Hình Toàn Cục
Các script tiện ích và cấu hình mặc định cho Claude Code:
- Tạo GitHub issue tự động
- Thiết lập MCP server với Peekaboo
- Quản lý tiêu đề terminal động
Cách Sử Dụng Linh Hoạt
Cho Người Dùng Cursor
Sao chép file .mdc vào thư mục .cursor/rules/ của dự án. Cursor sẽ tự động áp dụng quy tắc dựa trên glob patterns trong frontmatter.
Cho Người Dùng Claude Code
Thêm nội dung .mdc (không bao gồm frontmatter) vào file CLAUDE.md. Hoặc sử dụng cú pháp @import để tham chiếu toàn bộ file.
Tại Sao Chọn Định Dạng .mdc?
Định dạng Markdown với Cấu Hình (.mdc) mang lại sự thống nhất:
- Cursor hỗ trợ native với frontmatter YAML
- Claude Code đọc pure markdown
- Tương thích đa nền tảng AI
Hướng Dẫn Cài Đặt Toàn Diện
- Tạo thư mục cấu hình:
mkdir -p ~/.claude - Thêm rules toàn cục:
nano ~/.claude/CLAUDE.md - Cấu hình terminal (nếu cần): Sao chép script wrapper từ global-rules/
Đóng Góp Vào Dự Án
Chào đóng mọi đóng góp tuân thủ:
- Sử dụng đuôi .mdc
- Frontmatter YAML rõ ràng
- Hướng dẫn thực thi cụ thể
- Khả năng tái sử dụng cao
Repository hiện có hơn 1.2k stars và 61 forks, chứng tỏ sự hữu ích trong cộng đồng. Giấy phép MIT cho phép sử dụng tự do với mục đích thương mại.
