Skip to content

Commit 59e5b7c

Browse files
committed
기여 문서에 커밋 메시지 규칙 전체 공개(dartlab 준용)
- 변경 성격 + 실제 변경 내용, 주체 중립(1인칭 금지), 의도별 커밋 분할, 도구·생성 흔적 금지(훅 차단)를 CONTRIBUTING 2종(en/ko)에 명문화. 로컬 규칙 문서에만 있어 외부 기여자에게 안 보이던 것을 공개 표면으로.
1 parent 81e20eb commit 59e5b7c

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

CONTRIBUTING.ko.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ npm run serve # 브라우저 실측용 COOP/COEP 정적
4040
- 모든 커밋 전 `npm test` green.
4141
- **main 전용.** 이 저장소에서 로컬 브랜치 금지(훅이 non-main ref 차단). 외부 기여는 포크에서 `main`을 향해 온다.
4242
- 모든 `*.md`/`*.js`**em dash(U+2014) 금지.** 하이픈, 쉼표, 문장 재구성으로 대체. pre-commit 훅이 차단한다.
43-
- 커밋 메시지·주석·문서에 **도구·생성 흔적 금지**(commit-msg 훅이 특정 흔적 용어 목록을 차단한다). 커밋 메시지는 직접 쓴다: 변경 범주 + 무엇이 바뀌었는지. 저장소 관례는 한국어이고, 외부 기여는 명확한 영어도 받는다.
43+
- **커밋 메시지 규칙**(훅이 일부를 기계 차단한다):
44+
- 변경 성격 + 실제로 무엇을 바꿨는지 함께 담는다. 저장소 관례는 한국어이고, 외부 기여는 명확한 영어도 받는다.
45+
- **주체 중립**으로 쓴다(1인칭 자기참조 금지).
46+
- 한 작업에 여러 의도가 섞이면(새 기능 + 시그니처 변경 + 정리 등) **의도별로 커밋을 분할**한다.
47+
- **도구·생성 흔적 금지**: 모델명·도구명·생성 표식·공동 저자 트레일러를 커밋 메시지·주석·문서에 넣지 않는다. commit-msg 훅이 차단한다.
4448
- 버전은 `0.0.x` 라인 유지. 릴리즈 때만 올리고 태그와 `package.json`이 일치해야 한다. [docs/operations/release.md](docs/operations/release.md) 참조.
4549

4650
## PR 체크리스트

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ Browser validation: open `http://localhost:8788/examples/basic.html` and `proces
4040
- `npm test` must be green before every commit.
4141
- **main only.** No local branches in this repository; hooks block non-main refs. External contributions come from forks targeting `main`.
4242
- **No em dash (U+2014)** in any `*.md` or `*.js`. Use a hyphen, a comma, or rewrite the sentence. The pre-commit hook blocks it.
43-
- **No tool or generation traces** in commit messages, comments, or docs (the commit-msg hook blocks a specific trace-term list). Write commit messages yourself: category of change plus what changed. Korean is the repository convention; clear English is accepted for external contributions.
43+
- **Commit message rules** (partially machine-enforced by hooks):
44+
- State the nature of the change plus what actually changed. Korean is the repository convention; clear English is accepted for external contributions.
45+
- Write **subject-neutral** messages (no first-person self-reference).
46+
- If one piece of work mixes intents (new feature plus signature change plus cleanup), **split it into one commit per intent**.
47+
- **No tool or generation traces**: no model names, tool names, generation markers, or co-author trailers in commit messages, comments, or docs. The commit-msg hook blocks them.
4448
- Version stays on the `0.0.x` line; only releases bump it, and the tag must match `package.json`. See [docs/operations/release.md](docs/operations/release.md).
4549

4650
## Pull request checklist

0 commit comments

Comments
 (0)