Architecture Decision Record

Active theme: Light

← tài-liệu

Quy ước đặt tên tệp

Nếu bạn chọn tạo các ADR bằng các tệp văn bản thông thường, bạn có thể muốn đưa ra quy ước đặt tên tệp ADR của riêng mình.

Chúng tôi thích sử dụng quy ước đặt tên tệp có định dạng cụ thể.

Ví dụ:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Quy ước đặt tên tệp của chúng tôi:

  • Tên có một cụm động từ mệnh lệnh ở thì hiện tại. Điều này giúp dễ đọc và khớp với định dạng thông điệp commit của chúng tôi.

  • Tên dùng chữ thường và dấu gạch ngang (giống kho lưu trữ này). Đây là sự cân bằng giữa khả năng đọc và tính tiện dụng của hệ thống.

  • Phần mở rộng là markdown. Điều này hữu ích để định dạng dễ dàng.