메뉴
Git 커밋 메시지 및 브랜치 네이밍 컨벤션. 커밋, 브랜치 생성 시 참조합니다.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
TypeScript/JavaScript 코드 작성 시 일반적인 코딩 컨벤션을 적용합니다.
TypeScript 파일의 모든 메서드에 JSDoc 주석을 추가합니다.
PR 생성 전 코드 리뷰를 수행하고 이슈가 없으면 PR을 생성합니다.
| name | git-commit-convention |
| description | Git 커밋 메시지 및 브랜치 네이밍 컨벤션. 커밋, 브랜치 생성 시 참조합니다. |
| triggers | ["커밋","commit","브랜치","branch"] |
커밋 메시지 작성과 브랜치 네이밍에 대한 규칙을 정의합니다.
| 타입 | 설명 | 예시 |
|---|---|---|
feat | 기능 추가/변경 (입출력 변경 포함) | feat: 사용자 인증 API 추가 |
refactor | 리팩토링 (입출력 변경 없음) | refactor: UserService 메서드 분리 |
fix | 버그 수정 | fix: 로그인 토큰 만료 처리 오류 수정 |
docs | 문서 변경 | docs: README 설치 가이드 업데이트 |
chore | 기타 (빌드, 설정, 주석 등) | chore: UserService 주석 추가 |
test | 테스트 추가/수정 | test: UserService 유닛 테스트 추가 |
<type>: <subject>
<body (optional)>
제목(subject)
본문(body)
<type>-<description>
| 타입 | 브랜치 이름 |
|---|---|
| feat | feat-user-authentication |
| fix | fix-login-token-expiry |
| refactor | refactor-user-service-split |
| docs | docs-unit-test-convention |
| chore | chore-user-service-annotation |
/ 사용 금지, 하이픈 -만 사용)커밋:
feat: User Service 추가
- 유저 서비스 파일 추가
- findUserById 메서드 구현
브랜치: feat-user-model
update code (무엇을 업데이트했는지 불명확)fix bug (어떤 버그인지 불명확)WIP (작업 중인 상태로 커밋)asdf (의미 없는 메시지)feat/user-auth (슬래시 사용 금지)