© 2025 Sun* Inc. All rights reserved.

Giới thiệuChính sáchBáo lỗi

📜 Chính sách Áp dụng Coding Standards

Định nghĩa cách thức áp dụng, cập nhật, và tuân thủ các Rule trong hệ thống Coding Standards

Mục tiêu

Trang này nhằm định nghĩa rõ cách thức áp dụng, cập nhật, và tuân thủ các Rule trong hệ thống Coding Standards của chúng tôi.

Phạm vi áp dụng
  • Các rule áp dụng cho mọi project nội bộ, trừ khi được note rõ ngoại lệ.
  • Các rule có thể áp dụng cho outsourcing partner nếu được thống nhất từ đầu.
  • Một số rule mang tính bắt buộc ("Required"), số khác mang tính khuyến nghị ("Recommended").
Phân loại Rule
Mức độÝ nghĩaVí dụ
Required
Phải tuân thủ, có thể gây lỗi build hoặc bị reject PRKhông push secret vào repo
Recommended
Nên áp dụng nếu không có lý do hợp lý để bỏ quaSử dụng `guard clause` thay vì nested if
Nguyên tắc xác định mức độ
  • Gắn với độ nghiêm trọng khi vi phạm (security, stability, maintainability…)
  • Dựa trên best practices, kinh nghiệm thực chiến
Cách áp dụng trong dự án
  • Mỗi project có thể chọn danh sách Rule áp dụng (ví dụ: theo version `1.0`, hoặc custom theo nhu cầu)
  • Danh sách Rule áp dụng phải được commit vào repo tại `/docs/rules-applied.md` hoặc tương đương
Quy trình đóng góp / cập nhật Rule
  1. Mở Discussion với loại 💡 Đề xuất Rule hoặc cải tiến
  2. Được review bởi 2+ thành viên core team
  3. Sau khi thống nhất, tạo PR với Rule đầy đủ theo template chuẩn
Vai trò & Trách nhiệm
Vai tròQuyền hạn
Core ReviewerReview, approve, reject Rule mới
ContributorĐề xuất, thảo luận Rule
MaintainerMerge rule chính thức, cập nhật version
Chính sách version & cập nhật
  • Mỗi Rule có Rule ID duy nhất (ví dụ: C055)
  • Các Rule được gắn với version (VD: 1.0, 1.1...) để project có thể lock version theo thời điểm
  • Rule có thể được cập nhật mô tả mà không đổi mã nếu không thay đổi logic
Kênh góp ý & thảo luận
  • Góp ý: GitHub Discussion
  • Báo lỗi hoặc đề xuất Rule mới: mở issue theo template

Chính sách này được cập nhật lần cuối vào: 12/25/2025