.md 파일명 대소문자 구분 문의

작성한 질문수 4

0

안녕하세요 🙂

결론적으로 우선 파일명을 대/소문자로 사용하는건 개인, 팀의 스타일에 맞게 사용하시면 돼요.

하지만 질문 주신 파일 중 성격이 조금 다른게 있어요

1. CLAUDE.md는 클로드가 기억해야할 정보를 저장하는 파일이며 반드시 대문자로 작성하셔야돼요. 그 이유는 클로드 코드 스펙이 그러하기에 따라야해요.

2. README.md는 프로젝트의 성명이 담겨 있는 안내 문서로 오픈소스 세계에서 오래전부터 자리잡은 관례입니다. Github 같은 플랫폼에서 자동으로 인식해서 메인 페이지에 표시해주는 프로젝트 설명 파일이라고 보시면 돼요. 그리고 해당 파일을 대문자로 사용하는 이유는 관례예요. 축구할 때 축구화 농구는 농구공으로 하듯 프로젝트 설명 파일인 README.md 는 대문자를 사용하는 게 관례예요. 이는 코딩 경험을 쌓아가시면 자연스럽게 익숙해질거예요.

3. ROADMAP.md는 프로젝트의 계획 순서를 저장한 파일이에요. 이 파일을 대문자로 작성한 건 제 스타일이에요. CLAUDE.md, README.md처럼 프로젝트 전체를 안내하는 성격의 메타 문서라서, 같은 결로 묶이도록 대문자로 통일했어요. 그러면 폴더 열었을 때 위쪽에 한 번에 모여서 "아 이건 프로젝트를 설명하는 문서구나" 하고 눈에 잘 들어오거든요. 반대로 dev1.md, login.md처럼 개별 기능이나 작업을 다루는 문서는 소문자로 작성한 거예요.

dev1.md, dev2.md, login.md 해당 파일을 소문자로 한건 이건 진짜 예시입니다. git 설명하는데 "~~~~~한 개발을 했다" 고 가정한거예요. 실제로는 login.tsx, login.ts 이러한 소스코드일 거예요 그런데 git 설명하느라고 소문자로 입력한거예요.

결론적으로 말씀드리면 "약속된" 파일 외에는 대/소문자는 개인 또는 팀스타일에 맞게하시면 돼요!

실제로 팀이 일관된 스타일로 개발할 수 있도록 정하는 이러한 규칙을 팀 컨벤션(또는 개발 컨벤션, 코딩 컨벤션) 이라고 부릅니다.

감사합니다 🙂