Architecture Decision Record

Active theme: Light

← 문서

파일 이름 규칙

일반 텍스트 파일로 ADR을 작성하기로 했다면 ADR 파일 이름 규칙을 직접 정해 두는 것이 좋습니다.

우리는 특정 형식을 가진 파일 이름 규칙을 사용하는 것을 선호합니다.

예시:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

우리의 파일 이름 규칙:

  • 이름은 현재 시제 명령형 동사구로 짓습니다. 이는 가독성을 높이고 우리의 커밋 메시지 형식과 맞습니다.

  • 이름은 소문자와 대시를 사용합니다(이 저장소와 동일). 이는 가독성과 시스템 사용성 사이의 균형입니다.

  • 확장자는 markdown입니다. 서식을 쉽게 적용하는 데 유용할 수 있습니다.