문제 - 새 기능을 추가하는 절차가 starter-experience.md의 영어 단계 7개와 폴더 밖 파일 표뿐이다. 무엇을 고르는지(context, 계약 출처, 재시도 의미, 결과 불명, 인증, 페이지 템플릿), 어느 검사가 무엇을 못 잡는지, 실패 메시지가 어느 파일을 가리키는지는 리뷰 문서(16 영역 8절)에만 있다. 리뷰 문서는 복사한 프로젝트가 지울 수 있는 작업 이력이다. - create:feature(U7)가 생겼지만 그 인자, 만드는 파일, 사람이 해야 하는 일 (a11y 서명, 자리표시자 계약 신원 교체)을 설명하는 문서가 없다. 고른 방법 - docs/manual/을 한국어로 쓴다(결정 5). README(독자, 읽는 순서, 두는 것과 안 두는 것), 01 작업 순서 0~11단계, 02 결정표 6개, 03 기능 폴더 밖 파일, reference/ 4개(create-feature, global-ids, patterns, errors). - 01은 1단계에서 create:feature로 시작하는 길을 기본으로 두고, 단계마다 정할 것, 기준, 잡는 검사(명령·게이트 ID·메시지)와 못 잡는 것, 쓸 스킬을 적는다. 리뷰 시점의 "못 잡음"은 지금 코드로 다시 확인해 고쳤다(예: 루트 밖 라우트는 이제 앱 모듈이 적재 때 거부한다). - 실패 메시지는 src·scripts의 문자열을 그대로 옮기고 값 자리만 <...>로 바꿨다. - 목록 대신 정본 위치를 적는다(공통 원칙 8). route ID는 ROUTE_REGISTRY, 게이트는 config/ci/gates.json, 백엔드 멱등성 응답은 백엔드 템플릿 docs/web/http-contract.md §2를 가리키고 표를 옮기지 않는다. 공통 원칙은 design-docs의 conventions/feature-design-principles.md를 번호로만 가리킨다. - 03은 starter-experience.md의 폴더 밖 표를 정본으로 링크하고 복사하지 않는다. 생성 명령이 하는 것 / 사람이 꼭 하는 것 / 조건부 / 고치지 않는 것으로 나누고, 표에 없는 절차(a11y 서명, 자리표시자 교체, 기능 삭제)만 더한다. - 16 영역 8.4의 금지 목록(목표 디렉터리 구조 절, 예전 폴더 밖 표, 참조 페이지의 경로 문자열)은 링크하지 않고 README에 그 이유를 적는다. - 버린 대안: 리뷰 8절을 그대로 옮기기(리뷰 시점 사실이 지금 코드와 다르고 지울 수 있는 이력에 기댄다), starter-experience.md에 한국어 절을 더하기 (입구 문서는 영어이고 다른 에이전트 소유다), 실패 메시지를 요약해 쓰기 (메시지로 문서를 검색할 수 없다). 위험·한계 - docs/README.md §1 링크는 넣지 않았다(오케스트레이터 몫). 링크하기 전에는 verify:documentation이 이 폴더를 검사하지 않는다. 폴더 링크는 바로 아래 .md만 검사하므로 reference/도 따로 링크해야 한다. - 플랫폼 규칙 근거는 다른 에이전트가 옮기는 scale-architecture.md를 절 번호로 가리킨다. 이 커밋에는 그 파일이 없어 링크 대신 백틱 이름으로 썼다. - 매뉴얼로 막을 수 없는 것이 남는다. 기능 전용 e2e spec은 tests/e2e에만 둘 수 있어 기능 폴더 밖이다. --context reference-context는 참조 기능 테스트 하나를 깨뜨린다. 생성 드릴은 check:bundle을 돌리지 않는다. - "실험 E를 매뉴얼만 보고 다시 하기"는 문서로만 점검했고 실제로 다시 돌리지 않았다. 검증 - docs/README.md §1에 manual/, manual/reference/ 링크를 임시로 넣고 node scripts/verify-documentation-readiness.ts: PASS_SCOPED. 7개 문서 모두 missingPaths·missingScripts·unknownGateIds 0. 임시 링크는 되돌렸다. - 변이: patterns.md에 없는 경로·script·게이트 ID를 넣으면 세 항목을 모두 말하며 FAIL_UNVERIFIED. - 메시지 대조 스크립트: 백틱 안 148개 문구 중 106개는 코드에 그대로 있고, 42개는 코드가 조각을 이어 만드는 문구(접두어·필드 이름·값 채움)라 하나씩 코드에서 확인했다. - node scripts/run-vitest.ts run tests/unit/documentation-readiness.test.ts tests/unit/deletable-history-documents.test.ts tests/unit/repository-file-inventory.test.ts: 3파일 38건 통과.
9.0 KiB
03. 기능 폴더 밖 파일
핵심: 기능 하나에 필요한 파일은 거의 모두 src/features/<id>/와 tests/features/<id>/ 안에 있다.
폴더 밖 파일은 네 묶음으로 나뉜다.
기능 폴더 밖 파일
├─ A. 생성 명령이 만든다 → 사람은 확인만
├─ B. 사람이 꼭 해야 한다 → a11y 서명, 자리표시자 교체
├─ C. 조건이 맞을 때만 사람이 고친다 → 레이아웃, 새 capability, 제품 인증 프로필 등
└─ D. 고치지 않는다 → 중앙 카탈로그, governance, 공유 mock 등
정본 표: 파일마다 "언제 고치나"와 "안 고치면 무엇이 실패하나"는 docs/architecture/starter-experience.md의 "Adding a feature" 절 표(File | When | What fails without it)가 정본이다. 이 문서는 그 표를 복사하지 않는다. 그 표에 없는 것만 더한다. 누가 하는지, 왜 폴더 밖인지, 사람이 하는 절차.
링크: starter-experience.md "Adding a feature"
A. 생성 명령이 만든다
corepack pnpm create:feature가 쓰는 폴더 밖 파일은 둘이다. 있는 파일은 덮어쓰지 않는다.
src/contexts/<context>/context-module.ts- 새 context일 때만 만든다.
--context를 주면 만들지 않는다. - 왜 밖인가: context는 여러 기능이 함께 쓰는 소속 선언이다. 기능 하나가 갖지 않는다.
- 새 context일 때만 만든다.
artifacts/tests/a11y-manual/<ROUTE_ID>.md- 라우트마다 하나.
Status: pending-manual-review로 만든다. - 왜 밖인가: 수동 접근성 검토 기록은 라우트 단위로 한 폴더에 모은다. 릴리스 검토자가 한 곳에서 서명한다.
- pending 기록은 merge 게이트를 통과하고 릴리스 게이트를 넘지 못한다(원칙 7).
- 라우트마다 하나.
src/.generated/도 기능 폴더 밖이다. 생성기가 매번 다시 만든다. 손으로 고치지 않는다.
B. 사람이 꼭 해야 한다
수동 접근성 검토 서명
create:feature가 pending 기록을 만든다
→ merge: 형식만 본다 (review:a11y-manual -- --format-only, FE-GATE-009)
→ 릴리스 후보가 나온다
→ 사람이 그 후보로 라우트를 검토하고 기록에 서명한다
→ release: 서명을 본다 (review:a11y-manual, FE-GATE-028)
할 일:
- 릴리스 후보 하나를 띄운다.
docs/accessibility/manual-checklist.md의 M1~M7과 스크린 리더 항목을 그 라우트에서 확인한다.artifacts/tests/a11y-manual/<ROUTE_ID>.md를 채운다.Status: reviewed,Release ID,Reviewer,Reviewed at,Signature,Attestation: accepted- 항목마다
pass또는not-applicable (<구체적 이유>)
- 모든 라우트 기록의
Release ID가 같아야 한다.
안 하면: FE-GATE-028이 Manual accessibility evidence is incomplete:로 릴리스를 막는다.
생성 명령이 서명까지 하지 않는 이유: 자동으로 "검토함"을 쓰면 서명이 아무 뜻이 없어진다(원칙 7).
자리표시자 계약 신원 교체
패키지 인자 없이 만든 기능은 자리표시자 신원을 쓴다. staging·production에 내보내기 전에 바꾼다.
백엔드가 @org-contracts/<service> 패키지를 배포한다
→ 패키지를 제품 의존성으로 더한다
→ 의존성 변경 증거를 적는다
→ 기능 계약의 신원 네 필드를 바꾼다
→ 계약 기여가 패키지의 descriptor를 쓰게 바꾼다
→ 승인 검사로 확인한다
할 일:
- 패키지를 production 의존성으로 더한다.
package.json과 lockfile이 바뀐다. config/security/dependency-change-evidence.json에add:<name>@<version>항목을 더한다(owner,reviewer,reason,rollback).- 안 하면:
generate:supply-chain(check:bundle, FE-GATE-012 안에서 돈다)이high-risk dependency missing review: add:<name>@<version>로 실패한다.
- 안 하면:
src/features/<id>/contracts/<base>-feature-contract.ts의<BASE>_CONTRACT_PACKAGE에서 네 필드를 함께 바꾼다.packageId,version(정확한 SemVer),digest(sha256:+ 소문자 hex 64자리),sourceRevision(hex 7~64자리)- 자리표시자 상수 import를 지운다.
src/features/<id>/contracts/<base>-contract-contribution.ts가 로컬 descriptor 대신 패키지의 descriptor를 쓰게 바꾼다.@org-contracts/*import는 이 파일에서만 된다(external-contract-package-single-import-path).
- 공개 대상으로 승인 검사를 돌린다.
APP_PROFILE=staging으로 빌드한 뒤APP_PROFILE=staging RELEASE_TARGET=staging corepack pnpm check:release-admission(FE-GATE-027)을 돌린다.- 검사는 빌드 결과
dist/config.json을 읽는다. 빌드 변수는 루트README.md의 "Runtime configuration" 절에 있다.
안 하면: FE-GATE-027이 거절한다.
release admission refused for staging:
contractPackages.@org-contracts/<service>: pins the placeholder identity create:feature writes; pin the published package's version, digest and revision
생성 명령이 실제 신원을 만들지 않는 이유: 어느 백엔드 버전과 맞춰 빌드했는지는 사람이 정해야 한다(원칙 2).
C. 조건이 맞을 때만 사람이 고친다
언제와 실패 메시지는 정본 표에 있다. 여기에는 무엇을 위해 고치는지만 적는다.
src/contexts/<context>/context-layout.tsx: context가AppShell대신 자기 틀을 쓸 때. 예제:tests/helpers/fixture-layout-product.tsx.tests/e2e/accessibility.spec.ts: 경로 파라미터가:resourceId가 아닐 때, 또는 모든 API가[]를 답하면 그려지지 않는 보호 페이지일 때.src/bootstrap/product-composition.ts:needs에 템플릿이 만들지 않는 capability를 적었을 때. 제품 인증 프로필의 자격 증명도 여기서 준다.- 템플릿 파일
src/bootstrap/runtime-adapters.ts는 고치지 않는다.
- 템플릿 파일
src/contracts/product-contracts.ts: 제품 인증 프로필이나 제품 런타임 설정 키가 필요할 때.- 템플릿 파일
src/contracts/rest-profiles.ts는 고치지 않는다.
- 템플릿 파일
config/runtime/<profile>.json: 환경별로 기능을 끄고 싶을 때(FEATURE_OVERRIDES).package.json, lockfile,config/security/dependency-change-evidence.json: 계약 패키지를 더할 때(B절).
정본 표에 없는 것:
config/contracts/registry-baseline.json과 승인 파일: 레지스트리 행을 빼거나 바꿀 때만. 더하기만 하면 고치지 않는다. 절차는 01 문서 9단계.config/testing/risk-coverage.json의criticalModules: 기능 파일에 따로 커버리지 하한을 걸고 싶을 때(선택). 제거 드릴이 기능 폴더를 가리키는 행을 지운다.tests/e2e/<spec>.spec.ts: 기능 전용 브라우저 테스트가 필요할 때. Playwright는tests/e2e만 읽어서 기능 폴더 안에 둘 수 없다.
왜 이것들이 기능 폴더 밖인가: 제품 전체가 하나만 갖는 파일이다. 템플릿은 이 자리를 제품 소유로 비워 두었다. 템플릿을 동기화해도 제품의 내용과 충돌하지 않는다.
D. 고치지 않는다
기능을 더할 때 아래는 고치지 않는다. 고쳐야 할 것 같으면 무언가 잘못 고른 것이다.
src/features/installed-*.ts(중앙 카탈로그): 기능 폴더를 glob으로 읽는다.config/contracts/registry-governance.json: 라우트의 스키마·로딩 화면 값을 허용 목록으로 갖지 않는다.config/contracts/registry-baseline.json: 더하기만 하는 변경은 additive다.README.md,docs/accessibility/manual-checklist.md: route ID 목록을 갖지 않는다. 라우트별 기록 파일이 검사 대상이다.tests/mocks/아래 공유 파일: 기능 테스트는createHttpScenarioHandler에 기능 계약을 넘긴다. 공유 시나리오 카탈로그는 바뀌지 않는다.src/bootstrap/runtime-adapters.ts,src/contracts/rest-profiles.ts: 템플릿 소유. 제품은 C절의 제품 소유 파일을 쓴다.
기능을 지울 때
corepack pnpm test:sample-removal -- --feature=<id>는 복사본에서 지워 보고 게이트를 돈다. 실제 저장소에서 지울 때는 아래를 함께 지운다.
src/features/<id>/,tests/features/<id>/- 그 context의 마지막 기능이면
src/contexts/<context>/ artifacts/tests/a11y-manual/<ROUTE_ID>.md(라우트마다)- 남아도 검사는 실패하지 않는다. 검사는 등록된 라우트의 기록만 읽는다. 그래서 잊기 쉽다.
- 기능 전용
tests/e2e/spec config/runtime/<profile>.json의FEATURE_OVERRIDES키config/testing/risk-coverage.json에서 그 기능을 가리키는 행- 그 기능만 쓰던 제품 capability, 제품 인증 프로필, 계약 패키지 의존성
그다음 레지스트리 기준선을 다시 찍는다. 행을 빼는 것은 breaking 변경이다.
REGISTRY_BASELINE_OWNER=<담당> REGISTRY_BASELINE_REASON="<id> removed" corepack pnpm update:registry-baseline