AGENTS.md

AGENTS.md là file hướng dẫn Codex cách làm việc trong repo. Nó nên chứa những điều lặp lại trong nhiều tác vụ: lệnh, style, giới hạn, test và yêu cầu bàn giao.

AGENTS.md

Nếu không có rule file, mỗi lần giao việc bạn phải nhắc lại:

• Dùng package manager nào.
• Test/build chạy bằng lệnh nào.
• Thư mục nào không được sửa.
• Style code và format.
• Cách ghi kết quả.

AGENTS.md biến các quy tắc đó thành ngữ cảnh mặc định.

Đặt ở đâu

Thường đặt ở root repo:

AGENTS.md

Nếu mono-repo lớn, có thể thêm file ở từng package/module. Quy tắc gần file hơn nên cụ thể hơn.

Template đề xuất

# AGENTS.md

## Tổng quan dự án
Mô tả ngắn stack, mục tiêu và cấu trúc chính.

## Lệnh thường dùng
- Cài dependency: `pnpm install`
- Chạy dev: `pnpm dev`
- Test: `pnpm test`
- Build: `pnpm build`

## Quy tắc sửa đổi
- Giữ phạm vi nhỏ.
- Không format toàn repo nếu không được yêu cầu.
- Không đổi public API khi chưa nêu rõ.
- Không sửa file generated.

## Kiểm chứng
- Sau khi sửa code, chạy test liên quan.
- Sau khi sửa UI, chụp ảnh hoặc mô tả cách kiểm tra.
- Nếu không chạy được test, nói rõ lý do.

## Bảo mật
- Không đọc hoặc ghi secret.
- Không deploy, xóa dữ liệu hoặc đổi billing nếu chưa được duyệt.

## Bàn giao
- Liệt kê file sửa.
- Ghi lệnh đã chạy và kết quả.
- Nêu rủi ro còn lại.

Viết thế nào cho tốt

• Ngắn và cụ thể.
• Ưu tiên lệnh thật thay vì mô tả chung.
• Ghi điều cấm rõ ràng.
• Cập nhật khi workflow thay đổi.
• Không nhồi kiến thức không liên quan đến repo.

Phiên bản tối thiểu

# AGENTS.md

## Lệnh dự án
- Build: `pnpm build`
- Test: `pnpm test`

## Quy tắc
- Giữ thay đổi nhỏ.
- Không sửa file ngoài phạm vi tác vụ.
- Không commit hoặc push nếu chưa được yêu cầu.

## Bàn giao
- Nêu file đã sửa, lệnh đã chạy và rủi ro còn lại.

Bước tiếp theo: Sandbox và phê duyệt