코드 조직 계약과 모듈 문서 구조 추가#1
Merged
Merged
Conversation
- docs/generated/code-map.md의 자기 참조 링크를 db-schema.md로 교체. - Tests 행의 Source 컬럼을 judge-rubric.md 링크로 통일. - scripts/check-agents-doc.sh로 AGENTS.md 100줄 제한을 자동 검증. - ci.yml에 새 스크립트를 syntax check와 전용 단계로 추가.
- tests/는 .gitignore 대상이라 CI 체크아웃에는 디렉터리가 없음. - Tests 행 Source 컬럼을 평문 tests/로 되돌리고 gitignored, local-only 표기 추가. - check-doc-links의 broken link 오류 해소.
- 모듈 컨트랙트 생성 조건을 durable/multi-file surface 중심으로 정리. - Read Order Usage와 code-map/module-contract authority 관계를 문서화. - skill 변경을 runtime target bundle에 동기화.
gkrtjd99
commented
May 14, 2026
Owner
Author
gkrtjd99
left a comment
There was a problem hiding this comment.
검토했습니다.
확인한 내용:
- 코드맵, 모듈 컨트랙트, 개발 규칙 문서가 AGENTS/ARCHITECTURE/README의 역할 분리와 일관되게 추가되어 있습니다.
scripts/check-agents-doc.sh와 CI 단계가 AGENTS.md 100줄 제한을 자동 검증하며, 기존 shell/script 스타일과 맞습니다.skill/canonical source와targets/runtime bundle이sync-skill-targets.sh기준으로 동기화되어 있습니다.- PR #2 후속 변경까지 반영된 최종 head 기준으로 GitHub Actions
Repository CI2개가 모두 통과했습니다.
로컬 검증:
bash -n대상 스크립트 전체 통과bash starter-kit/scripts/lint-architecture.sh docs/design-docs통과bash starter-kit/scripts/check-doc-links.sh .통과bash starter-kit/scripts/lint-architecture.sh starter-kit/docs/design-docs통과bash starter-kit/scripts/check-doc-links.sh starter-kit통과bash scripts/check-agents-doc.sh통과bash scripts/sync-skill-targets.sh실행 후 clean worktree 확인bash scripts/check-bundle-structure.sh통과
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
변경 목적
서브에이전트가 작은 컨텍스트로 작업할 때 기존 함수, 컴포넌트, 스타일, 스크립트, 인프라 설정을 놓치고 병렬 구현이나 거대한 catch-all 파일을 만드는 문제를 줄이기 위한 문서 계약을 추가합니다.
이번 변경은
AGENTS.md를 상세 개발 매뉴얼로 키우지 않고, 짧은 네비게이션 맵 역할을 유지하면서 상세 규칙을 별도 문서로 분리하는 구조를 적용합니다.주요 변경
1. 생성 문서 구조 확장
skill/SKILL.md의 인터뷰 질문을 10개에서 11개로 확장했습니다.docs/references/development-rules.mddocs/generated/code-map.mddocs/module-contracts/README.md2.
AGENTS.md역할 재정의AGENTS.md는 계속 100줄 이하의 네비게이션 문서로 유지하도록 명시했습니다.docs/references/development-rules.md로 이동했습니다.AGENTS.md와starter-kit/AGENTS.md모두 읽기 순서, repository map, reference map 중심으로 정리했습니다.3. 전역 개발 규칙 추가
docs/references/development-rules.md에 다음 규칙을 추가했습니다.docs/generated/code-map.md와 관련docs/module-contracts/문서를 먼저 확인4. Code Map 추가
docs/generated/code-map.md를 추가해 다음 영역의 재사용 표면을 색인화하도록 했습니다.이 문서는 서브에이전트가 구현 전에 기존 구조를 빠르게 찾는 지도 역할을 합니다.
5. Module Contracts 추가
docs/module-contracts/README.md와 실제 저장소용 module contract 문서를 추가했습니다.docs/module-contracts/skill.mddocs/module-contracts/targets.mddocs/module-contracts/starter-kit.mddocs/module-contracts/scripts.md각 contract는 책임 범위, public entry points, 내부 재사용 표면, 파일 조직, 의존성 규칙, 검증 명령을 기록합니다.
6. Frontend, Backend, Infrastructure 템플릿 보강
starter-kit/docs/BACKEND.md추가starter-kit/docs/INFRASTRUCTURE.md추가starter-kit/docs/FRONTEND.md에 styling ownership, reuse rules, file size rules를 보강7. 배포용 target bundle 동기화
bash scripts/sync-skill-targets.sh를 실행해 canonicalskill/변경을 모든 runtime bundle에 반영했습니다.8. 평가/설계 문서 갱신
docs/design-docs/code-organization-contract.md를 추가해 설계 근거를 기록했습니다.docs/references/harness-engineering.md의 최소 harness contract를 갱신했습니다.사용자/개발자 영향
harness-init으로 생성하면AGENTS.md가 상세 규칙으로 비대해지지 않습니다.docs/references/development-rules.md에서 관리됩니다.code-map과module-contracts를 통해 기존 코드 표면을 확인하게 됩니다.검증
아래 검증을 실행했습니다.
bash -n scripts/sync-skill-targets.sh bash -n scripts/check-bundle-structure.sh bash -n skill/scripts/scan-project.sh bash -n starter-kit/scripts/check-doc-links.sh bash -n starter-kit/scripts/lint-architecture.sh bash scripts/sync-skill-targets.sh bash starter-kit/scripts/check-doc-links.sh . bash starter-kit/scripts/check-doc-links.sh starter-kit bash starter-kit/scripts/lint-architecture.sh docs/design-docs bash starter-kit/scripts/lint-architecture.sh starter-kit/docs/design-docs bash scripts/check-bundle-structure.sh git diff --check커밋
41c3002 feat: 코드 조직 계약 문서 추가