Skip to content

docs(readme): 한글 출력 요약 문서 갱신#90

Merged
JeremyDev87 merged 1 commit into
masterfrom
feature/82-readme-summary-smoke
May 1, 2026
Merged

docs(readme): 한글 출력 요약 문서 갱신#90
JeremyDev87 merged 1 commit into
masterfrom
feature/82-readme-summary-smoke

Conversation

@JeremyDev87

Copy link
Copy Markdown
Owner

배경

#82는 한글 기본 출력과 machine-readable summary 계약을 README와 실제 smoke 결과에 맞춰 문서화하는 최종 문서/검증 lane입니다.

변경 사항

  • README.md 예시를 기본 한글 scan summary 기준으로 갱신했습니다.
  • README.en.md--lang en 사용 흐름과 영어 출력 예시를 명시했습니다.
  • JSON top-level reportSummary와 SARIF runs[0].properties.reportSummary 계약을 README 양쪽에 문서화했습니다.
  • confirmedInitialPayloadKbSaveddirectionalOpportunityKb의 의미 차이를 설명해 dev/test-only duplicate가 LCP 개선처럼 보이지 않도록 정리했습니다.

검증

  • git diff --check
  • cargo run -q -p legolas-cli -- scan /Users/pjw/workspace/io/orbit-dashboard | sed -n '1,24p'
  • cargo run -q -p legolas-cli -- scan /Users/pjw/workspace/io/orbit-dashboard --lang en | sed -n '1,24p'
  • cargo run -q -p legolas-cli -- scan /Users/pjw/workspace/io/orbit-dashboard --json | jq -r '.schemaVersion, .reportSummary.language, (.reportSummary.confirmedInitialPayloadKbSaved|tostring), (.reportSummary.directionalOpportunityKb|tostring), ([.duplicatePackages[] | select(.impactScope == "dev-only")] | length | tostring)'
  • cargo test -p legolas-cli --test cli_contract
  • cargo test -p legolas-cli --test json_schema_contract
  • cargo test --workspace
  • cargo fmt --all --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • npm test

리뷰 게이트

  • Devil's Advocate Round 1: Low 1건
  • 조치: README.en.mdlegolas help --lang en 설명을 "exact contract"에서 "English command help"로 좁힘
  • Devil's Advocate Round 2: Findings 없음, review_loop_passed

브랜치 / 워크트리

  • base: master
  • branch: feature/82-readme-summary-smoke
  • worktree: /private/tmp/legolas-issue-82-readme-summary-smoke

이슈 연결

Closes #82

@JeremyDev87 JeremyDev87 added documentation Improvements or additions to documentation test labels May 1, 2026
README 예시를 기본 한글 출력과 --lang en 영어 출력에 맞춰 갱신하고 JSON/SARIF reportSummary 계약을 문서화합니다.

Closes #82
@JeremyDev87 JeremyDev87 force-pushed the feature/82-readme-summary-smoke branch from 26b9699 to 262d4bc Compare May 1, 2026 13:49
@JeremyDev87

Copy link
Copy Markdown
Owner Author

독립 fresh-session 리뷰 결과

  • Verdict: APPROVE
  • Severity Summary: Critical 0 / High 0 / Medium 0 / Low 0
  • Findings: 없음
  • Rationale: fresh-session 재리뷰에서 README 한국어/영어 예시와 reportSummary 문서 계약이 현재 CLI 출력과 일치한다고 확인했습니다. 로컬 검증과 최신 GitHub checks가 모두 통과했으므로 PR을 승인할 수 있습니다.
  • Note: GitHub 정책상 작성자 본인의 공식 approve는 제출할 수 없어 PR 코멘트로 동일 verdict를 남깁니다.

@JeremyDev87 JeremyDev87 self-assigned this May 1, 2026
@JeremyDev87 JeremyDev87 marked this pull request as ready for review May 1, 2026 14:07
@JeremyDev87 JeremyDev87 merged commit 5f06d22 into master May 1, 2026
8 checks passed
@JeremyDev87 JeremyDev87 deleted the feature/82-readme-summary-smoke branch May 1, 2026 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Sub] README 예시와 orbit-dashboard 스모크 검증 갱신

1 participant