Document: Project README Template
File:README.md
Version: v1.0.0
Created: 2026-06-14
Last Updated: 2026-10-09
Status: Template\
Thay nội dung trong ngoặc bằng thông tin đã được xác nhận của dự án. Xóa các mục không áp dụng.
[Mô tả vấn đề, mục tiêu, đối tượng sử dụng và bối cảnh của dự án.]
- [Mục tiêu hoặc kết quả hướng tới người dùng]
- [Chức năng chính]
Chỉ ghi các lựa chọn đã được xác nhận cho dự án.
| Hạng mục | Lựa chọn |
|---|---|
| Ngôn ngữ và phiên bản | [Điền theo dự án] |
| Framework web hoặc mô hình máy chủ | [Điền theo dự án] |
| Cơ sở dữ liệu | [Điền theo dự án hoặc không áp dụng] |
| Công cụ build và kiểm thử | [Điền theo dự án] |
| Môi trường chạy và triển khai | [Điền theo dự án] |
.
├── app/ # Mã nguồn ứng dụng, tổ chức theo dự án
├── database/ # Script và hướng dẫn cơ sở dữ liệu nếu cần
├── docs/ # Yêu cầu và tài liệu được duy trì
├── .agents/ # Policy, skills, workflow và script dùng chung cho Agent
└── .github/ # Mẫu Issue/PR và tự động hóa repository
- [Điều kiện tiên quyết và phiên bản]
- [Các bước cấu hình; không commit secret]
- [Lệnh build hoặc chạy được chọn cho dự án]
- [Cách truy cập hoặc sử dụng ứng dụng]
- Yêu cầu:
docs/requirements/ - Quy trình đóng góp:
CONTRIBUTING.md - Lịch sử thay đổi:
CHANGELOG.md - Hướng dẫn bảo trì template:
docs/template-maintenance.md(xóa khi tạo repository dự án mới)
| Tên | Vai trò | Liên hệ hoặc hồ sơ |
|---|---|---|
| [Tên] | [Vai trò] | [Liên kết] |