init: readme 작성 하네스 설계
This commit is contained in:
@@ -0,0 +1,78 @@
|
||||
schema-version: 1
|
||||
target:
|
||||
repository: /home/donghyeon/workspace/ai-tool/readme-harness
|
||||
readme-path: README.md
|
||||
mode: refresh
|
||||
profile-override: tool
|
||||
project-intent:
|
||||
purpose: 저장소에서 확인한 사실과 사용자가 정한 요구를 바탕으로 README 초안과 검토용 패치를 만드는 도구를 설명한다.
|
||||
positioning: 사용자 경로를 먼저 보여 주고, 명령·경로·문장 근거 검사와 사람 작성 내용 보존은 필요한 수준에서만 설명한다.
|
||||
maturity: 현재 Codex용 작성·검증 흐름을 지원하며 Claude와 Antigravity의 동일 동작은 아직 검증하지 않았다.
|
||||
audience:
|
||||
primary:
|
||||
- 저장소 README를 새로 만들거나 안전하게 갱신하려는 개발자
|
||||
secondary:
|
||||
- 하네스 검사와 프로파일을 확장하는 기여자
|
||||
reader-actions:
|
||||
- 첫 두 문장에서 어떤 결과를 만드는 도구인지 판단한다.
|
||||
- Codex에 README 작업을 요청하고 생성된 README와 패치를 확인한다.
|
||||
- 작업 목적에 맞는 모드를 고른다.
|
||||
- 검토한 패치만 명시적으로 적용한다.
|
||||
- 개발 환경과 테스트 방법은 별도의 개발 절에서 찾는다.
|
||||
content-policy:
|
||||
language: ko-KR
|
||||
tone: 독자 행동을 먼저 밝히는 직접적인 기술 설명체
|
||||
target-length: medium
|
||||
preserve-existing-copy: true
|
||||
detail-docs-policy: summary-and-link
|
||||
visual-policy:
|
||||
mode: when-useful
|
||||
max-visuals: 1
|
||||
preferred-formats:
|
||||
- diff
|
||||
placeholder-format: HTML 주석 기반 제작 사양
|
||||
terminology-policy:
|
||||
exact-identifiers: []
|
||||
explain-on-first-use: {}
|
||||
internal-only:
|
||||
family: 작업 담당 방식
|
||||
fan-out: 여러 담당자가 나눠 검토
|
||||
collapse: 한 담당자가 맡아 처리
|
||||
concrete worker: 실제 변경 담당자
|
||||
verification family: 검증 담당 역할
|
||||
route-to: 다시 작성할 지점
|
||||
public-surface-terms:
|
||||
allowed:
|
||||
- bootstrap
|
||||
- audit
|
||||
- refresh
|
||||
- section-update
|
||||
- readme-request.yaml
|
||||
- README.generated.md
|
||||
- README.patch
|
||||
- requirement-driven-readme
|
||||
explain-on-first-use: {}
|
||||
docs-only:
|
||||
- QUALITY_REVIEWED
|
||||
- READY_FOR_APPLY
|
||||
- claim-map.yaml
|
||||
- visual-plan.yaml
|
||||
- review-findings.yaml
|
||||
- quality-manifest.yaml
|
||||
must-include:
|
||||
- 한 문장 설명과 Codex 지원 범위
|
||||
- 실제 검토를 통과한 패치 미리보기와 원본 파일 링크
|
||||
- Codex 스킬 요청부터 생성 파일 확인, 성공 확인, 명시적 적용까지의 기본 사용자 경로
|
||||
- bootstrap을 기본 경로로 두고 audit, refresh, section-update를 보조 경로로 설명
|
||||
- 코드에서 확인한 사실, 사람 작성 내용 보존, 자동 적용 금지, 변경·비밀 값 차단 요약
|
||||
- 사용자 입력과 생성 파일을 세 개에서 네 개 수준으로 요약
|
||||
- 개발 환경 설치와 전체 테스트를 사용자 경로 뒤의 개발 절에 배치
|
||||
- 아키텍처, 시각 자료, 상태, 사용량, 품질 비교 상세 문서 링크
|
||||
- 현재 Codex 지원과 다른 도구의 동일 동작 미검증 한계
|
||||
must-exclude:
|
||||
- 빠른 시작의 첫 행동으로 테스트나 개발 의존성 설치를 제시하는 구성
|
||||
- 공개 README에서 내부 상태 이름, 내부 결과 파일, 게이트 계약을 설명하는 문장
|
||||
- 저장소 근거 없는 성능·품질 우월성 주장
|
||||
- 한 주장 마커가 여러 사실 문장을 덮는 구성
|
||||
- 제품 결과보다 먼저 나오는 내부 구조도
|
||||
protected-sections: []
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"git-sha": "636617ccd9f20440f21339f808557c096b55fec2",
|
||||
"dirty": true,
|
||||
"diff-hash": "sha256:77b1a19a536615064a4894d23c78b2e7aa54a9ef4cf13bad194ae40565407951",
|
||||
"scanned-at": null,
|
||||
"file-count": 231
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"schema-version": 1,
|
||||
"run-id": "20260720-public-readme",
|
||||
"repo-id": "readme-harness",
|
||||
"mode": "refresh",
|
||||
"target-repository": "/home/donghyeon/workspace/ai-tool/readme-harness",
|
||||
"harness-version": "0.1.0",
|
||||
"started-at": null,
|
||||
"tool-adapter": "codex",
|
||||
"input-hashes": {},
|
||||
"usage": {}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"schema-version": 1,
|
||||
"mode": "refresh",
|
||||
"current": "REPOSITORY_SNAPSHOTTED",
|
||||
"history": [
|
||||
{
|
||||
"state": "INITIALIZED"
|
||||
},
|
||||
{
|
||||
"state": "INPUT_CAPTURED",
|
||||
"gates": [
|
||||
{
|
||||
"name": "request",
|
||||
"ok": true,
|
||||
"warnings": [],
|
||||
"data": null
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"state": "REPOSITORY_SNAPSHOTTED",
|
||||
"gates": [
|
||||
{
|
||||
"name": "snapshot",
|
||||
"ok": true,
|
||||
"warnings": [],
|
||||
"data": {
|
||||
"diff-hash": "sha256:77b1a19a536615064a4894d23c78b2e7aa54a9ef4cf13bad194ae40565407951"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"rework": {
|
||||
"iterations": 0,
|
||||
"findings": {}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user