diff --git a/docs/agent-guides/commit-message-rules.md b/docs/agent-guides/commit-message-rules.md new file mode 100644 index 00000000..ddc6c67b --- /dev/null +++ b/docs/agent-guides/commit-message-rules.md @@ -0,0 +1,13 @@ +# commit-message-rules + +`SodaLive` 저장소의 커밋 메시지 규칙을 정리한 문서다. + +## 커밋 메시지 규칙 (표준 Conventional Commits) +- 기본 형식은 `(scope): `를 사용한다. +- `type`은 소문자(`feat`, `fix`, `chore`, `docs`, `refactor`, `test` 등)를 사용한다. +- 제목(description)은 한글로 작성하고, 명령형/간결한 현재형으로 작성한다. +- 이슈 참조 footer는 `Refs: #123` 또는 `Refs: #123, #456` 형식을 사용한다. + +## 커밋 메시지 검증 절차 +- `git commit` 직전/직후 `work/scripts/check-commit-message-rules.sh`를 실행해 규칙 준수 여부를 확인한다. +- 스크립트 결과가 `[FAIL]`이면 메시지를 수정한 뒤 다시 검증한다. diff --git a/docs/agent-guides/workflow-docs-commits.md b/docs/agent-guides/work-plan-docs.md similarity index 74% rename from docs/agent-guides/workflow-docs-commits.md rename to docs/agent-guides/work-plan-docs.md index ebc45c10..befbdfd0 100644 --- a/docs/agent-guides/workflow-docs-commits.md +++ b/docs/agent-guides/work-plan-docs.md @@ -1,18 +1,6 @@ -# workflow-docs-commits +# work-plan-docs -`SodaLive` 저장소에서 작업 절차, docs 계획 문서 규칙, 커밋 규칙을 정리한 문서다. - -## 커밋 메시지 규칙 (표준 Conventional Commits) -- 커밋 상세 가이드/절차는 `.opencode/skills/commit-policy/SKILL.md`를 단일 기준으로 사용한다. -- 커밋 작업 시작 시 `skill` 도구로 `commit-policy`를 먼저 로드한다. -- 기본 형식은 `(scope): `를 사용한다. -- `type`은 소문자(`feat`, `fix`, `chore`, `docs`, `refactor`, `test` 등)를 사용한다. -- 제목(description)은 한글로 작성하고, 명령형/간결한 현재형으로 작성한다. -- 이슈 참조 footer는 `Refs: #123` 또는 `Refs: #123, #456` 형식을 사용한다. - -### 커밋 메시지 검증 절차 -- `git commit` 직전/직후 `work/scripts/check-commit-message-rules.sh`를 실행해 규칙 준수 여부를 확인한다. -- 스크립트 결과가 `[FAIL]`이면 메시지를 수정한 뒤 다시 검증한다. +`SodaLive` 저장소에서 작업 절차와 PRD/계획/TASK 문서 규칙을 정리한 문서다. ## 작업 절차 체크리스트 - 변경 전: 유사 기능 코드를 먼저 찾아 네이밍/예외/응답 패턴을 맞춘다.