dr-dean/project-standards icon
public
Published on 6/11/2025
Project Standards

## Build & Development Commands - ## Testing Guidelines - ## Code Style & Guidelines - ## Documentation Guidelines -

Rules

Build & Development Commands

Testing Guidelines

Code Style & Guidelines

  • Sử dụng type hints nhất quán
  • Viết docstrings ngắn gọn cho functions và classes
  • Tuân thủ quy tắc PEP8 style guide
  • Comment code bằng tiếng Việt có dấu
  • Commit messages và PR descriptions viết bằng tiếng Việt

Documentation Guidelines

  • Tiếng Việt là ngôn ngữ chính thức trong mọi giao tiếp
  • Sử dụng tiếng Việt có dấu, chính tả đúng
  • Viết câu rõ ràng, tránh viết tắt không phổ biến
  • Giữ nguyên thuật ngữ kỹ thuật phổ biến, thêm chú thích khi cần
  • Sử dụng sentence case - không viết hoa tùy tiện
  • Trả lời trong khung chat chính, không duplicate nội dung
  • Xử lý từng file một lần, không hiển thị tất cả cùng lúc
  • Tránh trùng lặp - khi đã hiển thị code thì không lặp lại
  • Thảo luận, phân tích, Q&A giữ trong khung chat chính
  • Danh sách, tài liệu, code, markdown trình bày rõ ràng
  • Trả lời ngắn gọn, đi thẳng vào vấn đề
  • Tài liệu nước ngoài cần dịch sang tiếng Việt
  • Ngoại lệ: tên biến/hàm trong code, API docs, thư viện bên thứ ba