Skip to content

Task #83: Clarify README adoption and language support#84

Merged
postmelee merged 8 commits into
mainfrom
publish/task83
May 28, 2026
Merged

Task #83: Clarify README adoption and language support#84
postmelee merged 8 commits into
mainfrom
publish/task83

Conversation

@postmelee

Copy link
Copy Markdown
Owner

요약

  • 대상 타스크: Task: Clarify new-project adoption and copyable language support in README #83 README Quick Start와 Language support 진입 안내 보강
  • 왜: 기존 Quick Start는 기존 저장소 적용 중심이고, 새 프로젝트 사용자와 다국어/CLI 사용자가 바로 따라 하기 어려웠음
  • 무엇: 새 프로젝트용 복사 prompt, compact Language support, npx/Homebrew dry-run 안내를 영어·한국어·중국어 README에 정렬
  • 리뷰 포인트: adoption 단계와 제품 작업 분리, Language support의 간결성, 세 locale README 구조 정합성

변경 내역

  • Stage 1 (9bfe5a7): Quick Start를 기존 저장소와 새 프로젝트 경로로 분리
  • Stage 1.1 (12b2277): 새 프로젝트 안내를 설명문에서 복사 가능한 prompt 중심으로 보정
  • Stage 2 (c042abe): Language support에 복사 가능한 prompt/CLI 예시와 Homebrew 안내 추가
  • Stage 2.1 (9d99060): 반복 prompt를 제거하고 compact locale/CLI 안내로 축소
  • Stage 3 (f3c3204): 세 README의 구조, 링크, 명령, 문구 정합성 검증
  • 최종 보고 (fc2860a): 최종 수용 기준 검증과 오늘할일 완료 처리

영향 영역

영역 변경 리뷰 포인트
README Quick Start 기존 저장소 / 새 프로젝트 경로 분리 새 프로젝트 prompt가 adoption과 제품 작업을 명확히 분리하는지
README Language support locale 표, AI 언어 선택 설명, npx/Homebrew dry-run 예시 안내가 충분히 짧고 CLI가 판단 채널로만 설명되는지
작업 산출물 계획서, 단계 보고서, 최종 보고서 추가 Hyper-Waterfall 절차 추적성이 충분한지

작업 문서

핵심 리뷰 포인트

  • 새 프로젝트 prompt가 "brief는 참고용, 제품 계획/아키텍처/소스 코드는 adoption 이후 첫 Issue에서"라는 경계를 충분히 선명하게 전달하는지
  • Language support가 과도한 반복 없이 en, ko, zh-CN, npx, Homebrew 실행 경로를 이해시키는지
  • 세 README의 구조가 같은 순서와 의미를 유지하는지

검증

자동 검증

주제 검증 방법 결과 근거
Quick Start / Language support 검색 `rg -n "Existing repository New project Language support
locale entrypoint 링크 `rg -n "docs/agent-entrypoint\.en\.md docs/agent-entrypoint\.md docs/agent-entrypoint\.zh-CN\.md" README.md README.ko.md README.zh-CN.md`
adoption/product boundary `rg -n "product plans architecture documents source code
CLI 실행 경로 `rg -n "Language support 언어 지원 语言支持
반복 prompt 제거 `bash -lc 'if rg -n "Use locale en locale은 ko로 사용해줘 使用 zh-CN locale" README.md README.ko.md README.zh-CN.md; then exit 1; fi'`
whitespace git diff --check OK whitespace 오류 없음

수동/시나리오 검증

시나리오 확인 절차 결과 자료
세 README 구조 정렬 Quick Start와 Language support 섹션을 side-by-side로 확인 OK Stage 3 보고서
CLI/detail 중복 경계 상단 Language support와 하단 CLI/distribution details를 비교 OK Stage 3 보고서
수용 기준 종합 최종 보고서의 수용 기준 표 확인 OK 최종 보고서

검증 한계

  • PR 생성 전에는 GitHub Actions 원격 check가 아직 실행되지 않았다. PR 생성 후 check 결과를 확인해야 한다.

관련 이슈

  • 없음

후속 이슈 제안

  • 없음

남은 리스크

  • 없음

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@postmelee postmelee merged commit 2832945 into main May 28, 2026
1 check failed
@postmelee postmelee deleted the publish/task83 branch May 28, 2026 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants