docs(readme): 한글 출력 요약 문서 갱신#90
Merged
Merged
Conversation
README 예시를 기본 한글 출력과 --lang en 영어 출력에 맞춰 갱신하고 JSON/SARIF reportSummary 계약을 문서화합니다. Closes #82
26b9699 to
262d4bc
Compare
Owner
Author
|
독립 fresh-session 리뷰 결과
|
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.
배경
#82는 한글 기본 출력과 machine-readable summary 계약을 README와 실제 smoke 결과에 맞춰 문서화하는 최종 문서/검증 lane입니다.
변경 사항
README.md예시를 기본 한글 scan summary 기준으로 갱신했습니다.README.en.md에--lang en사용 흐름과 영어 출력 예시를 명시했습니다.reportSummary와 SARIFruns[0].properties.reportSummary계약을 README 양쪽에 문서화했습니다.confirmedInitialPayloadKbSaved와directionalOpportunityKb의 의미 차이를 설명해 dev/test-only duplicate가 LCP 개선처럼 보이지 않도록 정리했습니다.검증
git diff --checkcargo 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_contractcargo test -p legolas-cli --test json_schema_contractcargo test --workspacecargo fmt --all --checkcargo clippy --workspace --all-targets -- -D warningsnpm test리뷰 게이트
README.en.md의legolas help --lang en설명을 "exact contract"에서 "English command help"로 좁힘review_loop_passed브랜치 / 워크트리
masterfeature/82-readme-summary-smoke/private/tmp/legolas-issue-82-readme-summary-smoke이슈 연결
Closes #82