배경
프로젝트에는 JSON, Markdown(.md), XML, YAML(.yml/.yaml) 파일도 많이 사용되므로, 이들에 대한 코드/문서 형식 컨벤션도 필요하다 생각함
작업 항목
-
포맷별 스타일 가이드 조사
- JSON: 들여쓰기(spaces), 따옴표 방식(
" vs '), 콤마 뒤 공백, 속성 순서
- Markdown: 헤더(
# ), 리스트(-/*), 코드블록, 줄 길이, front-matter 형식
- XML: 들여쓰기, 속성 인용부호(
" vs '), self-closing 태그, 주석 스타일
- YAML: 들여쓰기(2/4 spaces), 키 순서, 따옴표 사용, 멀티라인 블록 옵션
-
컨벤션 문서화
- 프로젝트 루트에
CONVENTIONS.md 파일 생성
- 각 포맷별 규칙을 항목별로 정리 ex) JSON → 스페이스 2칸, 작은따옴표 금지