docs: USAGE 종료 코드 절 정리 및 검증 전제 문서화 - #85
Merged
Merged
Conversation
사용성 검토에서 나온 문서 구조 문제다. 종료 코드 절에 query --batch· compare·affected 설명이 표보다 먼저 끼어 있어 종료 코드를 찾는 독자와 명령 의미를 찾는 독자 모두 잘못된 위치를 읽게 됐다. - 세 명령 문단을 명령 절의 query --depth·rules 문단 사이로 이동 - 종료 코드 표의 1·2행을 실제 계약으로 확장(dead --explain 미도달 대상은 1, 얕은 클론에서의 Git 변경 파일 계산 실패는 2) - init의 pubspec 부재 경고와 skill 설치 경로·링크 교체 정책 문단 추가 - CONTRIBUTING에 check-analyzer-boundary의 ripgrep 전제 명시 - verify-cli-contract.sh가 exit-code 계약만 검증함을 헤더 주석으로 명시
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
1 participant
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.
배경
전체 개선 검토의 문서 구조 지적이다.
doc/USAGE.md의## 종료 코드절에query --batch·compare·affected설명 30줄이 표보다 먼저 끼어 있어, 종료 코드를 찾는 독자와 명령 의미를 찾는 독자 모두 잘못된 위치를 읽게 된다.변경 (문서·주석 전용, 제품 코드 무변경)
## 명령절의query --depth문단 뒤로 이동(내용 무변경).dead --explain의 미도달 대상도 1이다(기존 동작, help에는 PR #83에서 명시).--since·affected의 Git 변경 파일 계산 실패(얕은 클론)도 2다.init의 pubspec 부재 경고(PR feat(cli): 진단 메시지에 원인·경로·유효값 명시 및 help 계약 보강 #83)와skill설치 경로·링크 교체 정책(PR fix(core,cli): 원자적 쓰기 공용 경계로 통합해 skill 심볼릭 링크 관통 차단 #82/feat(cli): 진단 메시지에 원인·경로·유효값 명시 및 help 계약 보강 #83) 문단 추가.check-analyzer-boundary.sh의 ripgrep 전제 명시(로컬 rg 부재 시 exit 2 — CI는 설치돼 있음).tool/verify-cli-contract.sh: 헤더에 "exit-code 계약만 검증, 메시지 계약은 단위 테스트" 명시.검증
--help출력 및 구현과 대조dart pub publish --dry-run경고 0(clean git)