แนวปฏิบัติในการตั้งชื่อไฟล์

หากคุณเลือกเขียน ADR เป็นไฟล์ข้อความธรรมดา อาจเป็นประโยชน์ที่จะกำหนดแนวปฏิบัติในการตั้งชื่อไฟล์ ADR ของคุณเอง

เราชอบแนวปฏิบัติในการตั้งชื่อไฟล์ที่มีรูปแบบเฉพาะ

ตัวอย่าง:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

แนวปฏิบัติในการตั้งชื่อไฟล์ของเรา:

• ชื่อเป็นวลีกริยาแบบคำสั่งในกาลปัจจุบัน ซึ่งช่วยให้อ่านง่ายขึ้นและตรงกับรูปแบบข้อความ commit ของเรา

• ชื่อใช้ตัวพิมพ์เล็กและเครื่องหมายขีดกลาง (เหมือนในที่เก็บนี้) นี่คือความสมดุลระหว่างความอ่านง่ายและการใช้งานข้ามระบบ

• นามสกุลคือ markdown ซึ่งอาจสะดวกสำหรับการจัดรูปแบบอย่างง่าย