docs(ai): add submodule consumer check order and modification limits
Deploy Storybook / deploy (push) Successful in 1m11s
Deploy Storybook / deploy (push) Successful in 1m11s
This commit is contained in:
1 parent
6d32317b65
commit
fa7747cdbb
5 files changed
+25
-5
No files matched your search
+5
-1
@@ -120,7 +120,11 @@
|
||||
3. Figma 또는 기존 컴포넌트에 없는 텍스트를 추측해서 생성하지 않습니다.
|
||||
4. 기존 텍스트와 데이터를 임의로 변경하지 않습니다.
|
||||
5. 필요한 콘텐츠가 불명확하면 임의로 확정하지 않고 결과 보고에 확인 대상으로 적습니다.
|
||||
- **Git Submodule 사용 규칙(2026-10-23).** 소비 프로젝트에서 HMDesign을 사용할 때 요청 범위 밖은 바꾸지 않습니다. Submodule Commit 포인터는 사용자 승인 없이 바꾸지 않습니다. 소비 프로젝트의 기존 데이터와 기능을 우선 유지합니다.
|
||||
- **Git Submodule 사용 규칙(2026-10-23).** 소비 프로젝트에서 HMDesign을 사용할 때 요청 범위 밖은 바꾸지 않습니다. Submodule Commit 포인터는 사용자 승인 없이 바꾸지 않습니다. 소비 프로젝트의 기존 데이터와 기능을 우선 유지합니다. 연결 방식은 9절을 따릅니다.
|
||||
1. **확인 순서.** 컴포넌트를 적용하기 전에 (가) 연결된 Submodule의 실제 경로와 고정 Commit(`git submodule status`), (나) 그 Commit의 공통 `AI_GUIDE.md`(이 파일), (다) 사용할 패키지의 `ai/` 지침과 컴포넌트별 디자인 규칙(`DESIGN_RULES.md`, SW 뷰어는 `VIEWER.md`), (라) 실제 공개 Export·Props·사용법(카탈로그, 의심되면 `dist/*.d.ts`), (마) 소비 프로젝트의 기존 화면과 동작 순서로 확인한 뒤 적용합니다. 다른 Commit·원격 저장소·Storybook 배포본의 지침으로 대신하지 않습니다.
|
||||
2. **Storybook은 사용 예시로만.** Storybook은 조합·외형 참고용이며 실제 데이터·상태값·기본값의 기준이 아닙니다. 소비 프로젝트의 기존 상태값과 사용자 동작을 Storybook 예시로 교체하지 않습니다. 아이콘·문구·데이터·상태·기능 유지와 "원본 대비 변경" 보고는 아래 "기존 화면 전환 시 원본 보존"을 따릅니다.
|
||||
3. **Submodule 수정 금지.** 컴포넌트를 사용하는 작업은 소비 프로젝트의 코드만 변경합니다. HMDesign Submodule 내부의 소스·지침·설정·빌드 산출 설정을 고치지 않습니다(9절의 `npm ci`·`npm run build:packages`로 `dist/`를 만드는 것은 수정이 아님).
|
||||
4. **기능이 부족할 때.** HMDesign 컴포넌트가 필요한 기능을 지원하지 않으면 먼저 기존 Props·Slot·`children`·컴포넌트 조합(위 "없는 컴포넌트 처리 3단계")으로 대안을 검토해 적용 가능 여부를 보고합니다. HMDesign 패키지 자체 수정이나 Submodule Commit 변경이 필요하면 적용하지 말고 필요 사유와 범위를 적어 별도 승인을 요청합니다.
|
||||
- **기존 화면 전환 시 원본 보존(2026-10-23, 모든 화면·컴포넌트 — Header 포함).** 기존 화면을 HMDesign 컴포넌트로 전환·마이그레이션할 때 적용합니다. 위 "디자인 적용 시 변경 범위 제한"·"콘텐츠 생성 제한"·"Git Submodule 사용 규칙"과 함께 적용하며, 콘텐츠 생성 제한의 Header 예외는 기존 Header의 아이콘·문구·상태·기능을 바꾸거나 제거해도 된다는 뜻이 아닙니다.
|
||||
1. 원본과 같게 유지: 아이콘과 그 의미, 표시 문구·라벨·툴팁, 버튼·메뉴·입력 요소와 그 구성, 클릭·선택·입력 동작, 활성·비활성·선택·체크 등 상태 표시, 실제 데이터·기본값·표시 조건, 기존 기능과 사용자 작업 흐름. HMDesign 디자인 적용만을 이유로 제거·변경하지 않습니다.
|
||||
2. 제거·대체·변경은 다음 중 하나일 때만 허용합니다: (가) HMDesign 지침이 명시적으로 요구함, (나) HMDesign 컴포넌트가 그 요소·동작을 지원하지 않아 기존 형태 유지가 불가능함, (다) 사용자가 명시적으로 승인함. (나)는 먼저 기존 Props·Slot·`children`·조합(위 "없는 컴포넌트 처리 3단계")으로 유지할 수 있는지 확인한 뒤에만 인정하며, 지원하지 않는 그 요소 외의 다른 요소·기능은 바꾸지 않습니다.
|
||||
|
||||
Reference in new issue
Block a user