Skip to content

[docs] README를 최종 커밋 포맷 중심으로 재구성 - #38

Merged
coralstay merged 5 commits into
mainfrom
task/GF-136
Sep 26, 2026
Merged

coralstay merged 5 commits into
mainfrom
task/GF-136

Conversation

@coralstay

Copy link
Copy Markdown
Owner

GF-136. README를 구현 서술에서 최종 산출물 중심으로 재구성합니다. 203줄 → 163줄.

기존 순서("왜 만들었는지 → 무엇을 만들었는지 → 훅을 생애주기별로")는 읽는 사람이 정작 알고 싶은 "그래서 커밋이 어떤 모양이 되는가"에 도달하려면 훅 설명을 먼저 통과해야 했습니다.

새 구조

  1. 완성되는 커밋 예시 — 제목·본문·footer가 모두 채워진 실제 커밋 하나. 사람이 쓰는 부분과 훅이 붙이는 부분을 화살표로 구분
  2. 필드 표 2개 — 제목·본문(사람이 씀, 규칙 포함)과 트레일러(훅이 붙임). 각 필드의 의미 / 왜 필요한가 / 만드는 훅 / 값의 출처 / 신뢰 수준
  3. 훅 라이프사이클 표 — 커밋 경로만. 커밋 객체 존재 여부와 --no-verify 스킵 여부를 열로
  4. 범위 — lint 제외와 컨슈머 한계를 한 문단으로 압축

라이프사이클 표가 설계를 설명합니다

'커밋 객체가 있는가'와 '--no-verify로 건너뛰나'를 열로 넣으니 설계의 두 핵심이 표에서 바로 읽힙니다.

  • 에디터가 prepare-commit-msg보다 뒤에 열려서 그 훅은 최종 메시지를 볼 수 없습니다 → 그래서 에디터 경로를 거부합니다
  • 4단계에서 커밋이 이미 만들어지므로 post-commit은 커밋을 막을 수 없습니다 → 그래서 검사가 아니라 기록만 합니다

28행짜리 전체 훅 목록은 커밋 경로 5행으로 줄였습니다. 나머지 23행은 전부 —였고, 커밋 단계만 다룬다는 원칙은 한 문장으로 충분합니다.

압축

GF-135가 늘린 네 곳을 걷어냈습니다 — 언어 lint 범위 설명 두 문단, 컨슈머 한계 인용 블록, prepare-commit-msg 중첩 불릿, 재설계 진행 알림 블록. 사실은 손실되지 않았습니다(없어진 정보는 decision-18/23과 doc-15에 있습니다).

예시를 실제 값으로 검증했습니다

초안에 AI-Agent: claude-code/2.1.267 (claude-opus-5)를 썼는데 그건 GF-128 예정이고 현재 사실이 아닙니다. 실제 footer는 아직 AI-Tool/AI-Tool-Version/AI-Model 세 줄로 나뉘어 있어서, 자기 커밋의 footer를 뽑아 대조해 정정했습니다.

갱신이 필요한 시점

표의 '만드는 훅' 열이 현재 전부 post-commit입니다. GF-127이 검증을, GF-128이 트레일러 삽입을 prepare-commit-msg로 옮기면 이 열과 라이프사이클 표를 갱신해야 합니다. GF-134가 최종 아키텍처 반영과 hooks/README.md를 맡습니다.

🤖 Generated with Claude Code

coralstay and others added 5 commits September 26, 2026 16:56
README가 구현 서술 중심이라 "그래서 커밋이 어떤 모양이 되는가"에
도달하려면 훅 설명을 먼저 통과해야 한다. 최종 산출물 중심으로 재배치하고
각 필드의 의미와 생성 시점, 이유를 표로 정리한다.

GF-135에서 거짓 서술을 걷어내며 오히려 늘린 분량도 함께 압축한다.

아직 태스크가 아니다 - 승격은 별도 커밋으로 남긴다.

Task-Id: GF-136
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AI-Tool: claude-code
AI-Tool-Version: 2.1.267
Co-Authored-By: Claude <noreply@anthropic.com>
AI-Model: claude-opus-5
Tokens-Used: 10259703
Tool-Calls: 8
Hooks-Commit: fad91f7
Signed-off-by: cpu-once <231006716+cpu-once@users.noreply.github.com>
필드 표에 그 필드를 만드는 훅 이름을 적고, 커밋 한 번에 훅이 도는 순서와
각 단계에서 커밋 객체가 존재하는지를 함께 정리한다. --no-verify가 어느
훅을 건너뛰는지도 표시한다 - 어떤 필드가 우회 가능한지가 거기서 갈린다.

Task-Id: GF-136
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AI-Tool: claude-code
AI-Tool-Version: 2.1.267
Co-Authored-By: Claude <noreply@anthropic.com>
AI-Model: claude-opus-5
Tokens-Used: 6488496
Tool-Calls: 4
Hooks-Commit: 8848a5d
Signed-off-by: cpu-once <231006716+cpu-once@users.noreply.github.com>
Task-Id: GF-136
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AI-Tool: claude-code
AI-Tool-Version: 2.1.267
Co-Authored-By: Claude <noreply@anthropic.com>
AI-Model: claude-opus-5
Tokens-Used: 1952818
Tool-Calls: 2
Hooks-Commit: c828491
Signed-off-by: cpu-once <231006716+cpu-once@users.noreply.github.com>
구현 서술 순서(왜 만들었는지 → 무엇을 만들었는지 → 훅 생애주기)라
"그래서 커밋이 어떤 모양이 되는가"에 도달하려면 훅 설명을 먼저 통과해야
했다. 완성된 커밋 예시를 맨 앞에 두고 각 필드의 의미, 만드는 훅,
신뢰 수준을 표로 정리했다.

훅 라이프사이클 표는 28행 중 커밋 경로만 남기고, 커밋 객체가 존재하는지와
--no-verify가 어느 훅을 건너뛰는지를 열로 넣었다. 에디터가 훅보다 뒤에
열린다는 사실과 post-commit이 커밋을 막을 수 없다는 사실이 그 표에서
바로 읽힌다.

203줄에서 163줄로 줄었다. 예시는 현재 실제로 생성되는 footer 그대로다 -
AI-Agent 병합은 GF-128 예정이라 아직 세 트레일러로 나뉘어 있다.

Task-Id: GF-136
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AI-Tool: claude-code
AI-Tool-Version: 2.1.267
Co-Authored-By: Claude <noreply@anthropic.com>
AI-Model: claude-opus-5
Tokens-Used: 15172793
Tool-Calls: 12
Hooks-Commit: 935817e
Signed-off-by: cpu-once <231006716+cpu-once@users.noreply.github.com>
203줄에서 163줄로 줄었고 테스트 93개 통과. 예시 footer를 자기 커밋에서
뽑아 대조해 정정했다 - 초안에 쓴 AI-Agent 병합 형식은 GF-128 예정이고
현재 사실이 아니어서 세 트레일러로 되돌렸다.

표의 "만드는 훅" 열이 현재 전부 post-commit이므로, GF-127/128이 검증과
트레일러 삽입을 옮기면 갱신해야 한다는 점을 남겼다.

Task-Id: GF-136
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AI-Tool: claude-code
AI-Tool-Version: 2.1.267
Co-Authored-By: Claude <noreply@anthropic.com>
AI-Model: claude-opus-5
Tokens-Used: 1337346
Tool-Calls: 2
Hooks-Commit: d03e696
Signed-off-by: cpu-once <231006716+cpu-once@users.noreply.github.com>
@coralstay
coralstay merged commit 72755d0 into main Sep 26, 2026
2 checks passed
@coralstay
coralstay deleted the task/GF-136 branch September 26, 2026 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant