Chuyển tới nội dung chính

Hướng dẫn đóng góp

Hướng dẫn cho developer muốn đóng góp vào tài liệu và codebase của Bot Bán Hàng.

Quy trình đóng góp​

  1. Fork repo về tài khoản cá nhân
  2. Tạo branch mới từ main — đặt tên theo format feature/<tên-tính-năng> hoặc fix/<mô-tả-lỗi>
  3. Code theo Quy tắc code của team
  4. Tạo Pull Request, mô tả rõ thay đổi
  5. Chờ review và merge

Quy tắc viết tài liệu​

  • Viết bằng tiếng Việt, thuật ngữ kỹ thuật giữ nguyên tiếng Anh
  • Mỗi module/service có 1 file riêng
  • Cấu trúc mỗi trang: Mô tả → API Endpoints → Request/Response → Ví dụ
  • Sử dụng code block có syntax highlighting

Cài đặt môi trường docs​

cd vn.merchant.docs
pnpm install
pnpm dev

Docs chạy trên http://localhost:3000.

Contents