ttipo
700a100a38
규칙과 구현이 어긋나 있던 부분을 바로잡고, 작업하며 발견한 함정을 기록한다.
- 스킬 문서의 "기본 제공 골격" 표를 실제 파일 목록과 일치시킴
- 커밋 전 체크리스트에 테스트 실행·에러 코드 동기화 절차 추가
- 커밋 규칙에 scope·브랜치 전략·PR 규칙 보강
- 새 규칙 파일(api-design, logging)을 CLAUDE.md import 목록에 등록하고,
규칙 추가 시 등록이 필수라는 메타 규칙 명시
- README 를 현재 구조에 맞게 갱신 (traceId·페이지네이션·에러 코드 SSOT·로컬 개발 명령)
작업 중 실제로 겪은 함정들을 규칙으로 남긴다:
- Windows 에서 npm install 하면 Linux 전용 optional 의존성이 lock 에서 잘려
Docker 의 npm ci 가 실패한다 → 의존성 변경은 컨테이너 안에서 수행
- --build 만으로는 node_modules 익명 볼륨이 갱신되지 않아
새 패키지가 컨테이너에 반영되지 않는다 → --renew-anon-volumes 필요
- compose 는 미정의 변수를 빈 문자열로 주입해 Number('')===0 함정이 생긴다
- dev 는 PID 1 이 npm 이라 graceful shutdown 확인은 운영 이미지로 해야 한다
- Redis 는 컨테이너만 떠 있고 사용처가 없다 — 확장 지점임을 명시
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Git 컨벤션
커밋 메시지
<type>(<scope>): <제목> 형식 — scope 는 선택.
- type: feat / fix / refactor / docs / chore / perf / test / style
- scope: 변경이 한 스택에 한정되면 명시 —
backend/frontend/flutter/docker/rules - 제목은 한국어, 명령형 현재 시제, 마침표 없음
- 한 커밋은 하나의 논리적 변경만 포함
feat(backend): 사용자 목록 커서 페이지네이션 추가
fix(frontend): 세션 만료 시 중복 알림 노출 수정
docs(rules): 에러 코드 SSOT 동기화 절차 정리
본문이 필요하면 제목 다음 줄을 비우고 왜 바꿨는지 적는다(무엇을 바꿨는지는 diff 가 말해준다).
브랜치
<type>/<간단한-설명> — 기본 브랜치는 main.
feat/user-pagination
fix/session-expired-alert
- 기본 브랜치에 직접 커밋하지 않는다. 작업은 브랜치에서 하고 PR 로 합친다.
- 브랜치는 머지 후 삭제한다. 오래 유지되는 브랜치를 만들지 않는다.
PR
- 제목은 커밋 규칙과 동일한 형식
- 본문에 무엇을 왜 바꿨는지와 확인 방법을 적는다
.github/pull_request_template.md의 체크리스트를 채운다- 머지 전 CI(
.github/workflows/ci.yml)와 checklist 의 "커밋 전 공통 점검"을 통과해야 한다 - 에러 코드·응답 포맷 등 공유 계약을 바꾸는 PR 은 세 스택 영향 범위를 본문에 명시한다 (error-codes · response-format)