From 776a6ec68d16525a9d7cb8502d7d32022676d74b Mon Sep 17 00:00:00 2001 From: DongHyeonka Date: Wed, 11 Nov 2026 20:55:32 +0900 Subject: [PATCH] =?UTF-8?q?docs(manual):=20=EC=9E=91=EC=97=85=20=EB=A7=A4?= =?UTF-8?q?=EB=89=B4=EC=96=BC=EA=B3=BC=20=EA=B2=B9=EC=B9=98=EB=8A=94=20?= =?UTF-8?q?=EC=99=84=EB=A3=8C=20=EA=B8=B0=EC=A4=80=20=EC=82=AC=EB=B3=B8?= =?UTF-8?q?=EC=9D=84=20=EC=A7=80=EC=9A=B4=EB=8B=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 문제: 이 브랜치는 SPEC.md의 공통 완료 기준을 docs/manual/reference/done-criteria.md로 옮겼다. 하네스 PR #13은 같은 기준을 작업 매뉴얼 docs/work/improve.md 5절로 옮겼다. 같은 규칙의 사본이 둘이면 하나만 고쳐져 갈라진다. 고른 방법: 소유자 결정 D5가 말한 「매뉴얼」은 일하는 순서를 정하는 작업 매뉴얼(docs/work/) 쪽이 맞아서 개발 매뉴얼 사본을 지운다. 매뉴얼 README의 그 행과 CHANGELOG 줄을 고친다. 위험: 없음에 가깝다. 사본은 이 브랜치에서 생겼고 다른 문서가 가리키지 않는다. 검증: `git grep -n done-criteria`가 CHANGELOG의 이력 줄 밖에서 0건. --- CHANGELOG.md | 2 +- docs/manual/README.md | 3 +-- docs/manual/reference/done-criteria.md | 31 -------------------------- 3 files changed, 2 insertions(+), 34 deletions(-) delete mode 100644 docs/manual/reference/done-criteria.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d0d08db..efd60bc1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -98,7 +98,7 @@ - 살아 있는 문서를 모두 한국어로 옮겼다(현재 계약, 운영, runbook, 보안, 스타일, 접근성, 테스트, 모듈 README). 뜻은 바꾸지 않았고 백틱 안, 링크 대상, 절 번호, 표 구조는 그대로다. 문서를 읽는 테스트의 기대 문자열(`tests/unit/feature-tracked-files.test.ts`)과 절 이름을 인용한 주석을 같이 고쳤다 (`af10cae9`, `45e8cb77`, `11530b1a`). - `check:remediation-ledger`는 옮긴 원장의 절 제목 `## 세 번째 재검토 (2026-08-14)`을 찾고, 「모두 닫혔다」를 한국어로도 잡는다 (`45e8cb77`). -- `SPEC.md`의 공통 완료 기준은 `docs/manual/reference/done-criteria.md`로 옮겼다 (`ee5e19f4`). +- `SPEC.md`의 공통 완료 기준은 하네스 범위가 `docs/work/improve.md` 5절로 옮겼다. 이 범위가 먼저 만든 사본 `docs/manual/reference/done-criteria.md`는 지웠다(`ee5e19f4`에서 만들고 뒤 커밋에서 지움). - 설정 파일의 설명 칸(recipe 카탈로그, runbook 등록, 규모 상한, 짝 백엔드 pin의 `fact`, secret scan 허용 이유)을 한국어로 옮겼다. 키와 값의 모양은 그대로다 (`309631e4`). ### 알려진 제한 diff --git a/docs/manual/README.md b/docs/manual/README.md index effc0e1d..70964591 100644 --- a/docs/manual/README.md +++ b/docs/manual/README.md @@ -22,7 +22,7 @@ README (이 문서) → 02 결정표 (단계 중 "무엇을 고를지" 막힐 때) → 03 기능 폴더 밖 파일 (폴더 밖을 고쳐야 할 때) → 04 짝 백엔드에 처음 붙이기 (로그인이 필요한 API를 처음 부를 때) - → reference/ (명령 인자, 전역 ID, 패턴, 오류 메시지, 완료 기준을 찾아볼 때) + → reference/ (명령 인자, 전역 ID, 패턴, 오류 메시지를 찾아볼 때) ``` | 문서 | 내용 | @@ -35,7 +35,6 @@ README (이 문서) | [`reference/global-ids.md`](reference/global-ids.md) | 전역 ID 종류, 생성 명령이 만드는 값, 유일성 검사 | | [`reference/patterns.md`](reference/patterns.md) | 기능 개발 패턴과 예제 위치. 예제가 없는 패턴은 "없음" | | [`reference/errors.md`](reference/errors.md) | 생성·조립·레지스트리 검사의 실패 메시지와 고칠 파일 | -| [`reference/done-criteria.md`](reference/done-criteria.md) | 기능 추가나 수정을 끝났다고 하기 전에 맞춰 보는 완료 기준(테스트, 게이트, 구조, 커밋) | ## 자주 나오는 말 diff --git a/docs/manual/reference/done-criteria.md b/docs/manual/reference/done-criteria.md deleted file mode 100644 index c3cf6463..00000000 --- a/docs/manual/reference/done-criteria.md +++ /dev/null @@ -1,31 +0,0 @@ -# 완료 기준 - -기능을 더하거나 결함·리뷰 발견을 고친 변경을 "끝났다"고 하기 전에 맞춰 보는 기준이다. -2026-09-25 리뷰 수정 라운드의 공통 완료 기준을 그 라운드 밖에서도 쓰도록 옮겼다. -옮기기 전 원문은 그 라운드의 요구사항(`docs/history/plans/2026-09-25-review-fix-round/SPEC.md`)에 있다. -게이트 목록은 여기에 적지 않고 정본을 가리킨다(원칙 8). - -## 테스트 - -1. 동작을 바꾸는 변경은 재현 테스트가 먼저 실패하고(RED), 고친 뒤 통과한다(GREEN). - - 브라우저 없이 재현할 수 없는 조건은 fake나 fixture로 만든다. - - 브라우저에서만 드러나는 동작이면 Playwright spec을 하나 더한다. -2. 테스트가 결함을 잡지 못한 것(변이가 살아남음)이 문제였으면, 그 변이를 다시 넣었을 때 새 테스트가 실패하는지까지 본다. - -## 게이트 - -3. 변경마다 merge 단계 게이트가 모두 통과한다. - - 목록과 각 게이트가 부르는 명령은 `config/ci/gates.json`이 정본이다. - - 로컬에서는 `corepack pnpm ci:gate -- <게이트 ID>`로 하나씩 돌린다. 돌리는 법은 루트 `README.md`의 「검증」 절에 있다. -4. 여러 변경을 합칠 때(병렬 작업을 통합할 때)는 3에 더해 `corepack pnpm build`와 `corepack pnpm test:sample-removal`도 돌린다. - -## 구조와 계약 - -5. `src/adapters/` 아래 파일을 더하거나 옮기면 `docs/reviews/adapters/INVENTORY.md`를 같은 변경에서 고친다. `corepack pnpm check:adapter-inventory`가 대조한다. -6. 여러 adapter가 같이 쓰는 로직은 `src/adapters/platform/`(kernel)이나 `src/contracts/`에 둔다. 새 파일 단위 예외 규칙은 만들지 않는다(`.dependency-cruiser.json`). -7. 공개 포트는 더하기만 한다. 기존 시그니처를 깨야 하면 결정 기록(`docs/adr/`)을 남기고 `CHANGELOG.md`에 BREAKING으로 적는다. - -## 커밋과 문서 - -8. 논리적 변경 하나에 커밋 하나다. 리뷰 발견을 고친 커밋은 메시지에 발견 ID를 적는다. 그 변경이 바꾼 파일만 스테이징한다. -9. 문서를 바꾸는 변경은 문서의 주장마다 코드 위치를 가리키는지로 확인한다. 문서와 코드가 다르면 코드가 맞다.