CLAUDE.MD 작성법

절대 규칙 (맨 위에 배치)

• 프로덕션 DB 직접 쿼리 금지, 시크릿 파일 커밋 금지 등

아키텍쳐

• 폴더 구조를 트리 형태로

빌드 / 테스트 명령어

• pnpm dev, pnpm test - Claude가 알아서 빌드 & 테스트 실행

도메인 컨텍스트

• 비즈니스 로직

코딩 컨벤션

• 네이밍 규칙, 커밋 메시지 포맷

근데 매번 CLAUDE.MD를 읽기 때문에 크기가 커지면 커질수록 토큰 소모량이 커짐.
CLAUDE.MD는 300자 이내로 유지하는게 토큰 효율적임
프로젝트가 커지면 당연하게 CLAUDE.MD 역시 커질 수 밖에 없음
이럴 땐 폴더 별로(API / WEB / DB) 이런식으로 나눠서 CLAUDE.MD를 따로 작성해줌. 이런 경우 더 가볍고 효율적이게 움직임

CLAUDE.MD를 직접 수정할 필요는 없음
클로드코드에게 @@패턴을 CLAUDE.MD에 추가해줘 만 하면 알아서 저장해줌

또한 Trigger-Keyword 를 등록할 수 있음.

Trigger-Keyword란?

여러 스텝이 있는 과정을 하나의 명령어로 실행할 수 있는 것
예를 들어 깃에 push하는 과정
테스트 -> git add -> git commit -m "message" -> git push -> 과정 요약 정리
이 과정을 특정 키워드로 바로 실행하도록 명령하는 설계를 넣어줄 수 있음.
반복 작업 및 여러 작업이 있는 경우 설정해두면 편리

이거와 비슷한 기능이 슬래시 커맨드로 만들 수 있음 (반복적인 작업)

"배포" or "ship"
테스트 -> git add -> git commit -m "message" -> git push -> 과정 요약 정리 이걸 슬래시 커멘트로 만들어줘 ~
라고 하면
.claude / commands / ship.md 라는 파일이 아래와 같이 만들어짐

Ship Command
Git add, commit, push를 자동으로 수행하는 명령어입니다.

실행 단계
변경 사항 확인: git status와 git diff를 실행하여 변경된 파일 목록과 내용을 확인합니다.
파일 분석: 변경된 파일들의 내용을 읽고 분석합니다.
커밋 메시지 생성: 변경 내용을 기반으로 적절한 커밋 메시지를 생성합니다.
Conventional Commits 형식 사용 (feat, fix, refactor, docs, chore 등)

한글로 작성
변경의 "무엇"보다 "왜"에 초점
Git 작업 수행:
git add - 변경된 파일 스테이징
git commit - 생성된 메시지로 커밋
git push - 원격 저장소에 푸시

주의사항
민감한 파일(.env, credentials 등)이 포함되어 있으면 경고하고 사용자에게 확인을 요청합니다.
커밋 전에 생성된 메시지를 사용자에게 보여주고 확인을 받습니다.
push 실패 시 원인을 분석하고 해결 방법을 제안합니다.

실행
위 단계를 순서대로 수행하세요. 각 단계에서 문제가 발생하면 사용자에게 알리고 진행 여부를 확인합니다.