docs(readme): audit 신호 정책 문서화#111
Merged
Merged
Conversation
README에 env secret heuristic, env config schema, tsconfig noise policy를 추가한다. Closes #106
Owner
Author
|
독립 fresh-session 리뷰 결과
참고: GitHub 정책상 self-authored PR에는 공식 approve review를 제출할 수 없어, 동일한 독립 리뷰 verdict를 PR comment로 게시합니다. |
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.
Summary
audit signal quality 개선 이슈의 최종 사용자-facing 계약을 README에 문서화했습니다.
Related Issues
Changes Made
README.md에 env contract secret 판정, env config schema, tsconfig no-op exclude 정책을 추가했습니다.README.en.md에 동일한 영문 설명을 추가했습니다.Testing
git diff --checkcargo metadata --format-version 1 --no-depscargo test -p maximus-corecargo test -p maximus-clicargo test -p maximus-checks --test env_checks --test tsconfig_checksnpm testnode --test test/installed-native-runtime.test.jscargo run -p maximus-cli -- audit /Users/pjw/workspace/io/orbit-dashboard --only env,tsconfig --fail-on noneContract Impact
cargo run -p maximus-cli -- audit /Users/pjw/workspace/io/orbit-dashboard --only env,tsconfig --fail-on noneNEXT_PUBLIC_OKTA_MOCKremains an error.env-example-secretwarnings remain for token/service-key style keys such asAI_READINESS_INGEST_TOKEN,GH_COLLECTOR_TOKEN,GITHUB_TOKEN,RMBR_CCP_TELEMETRY_TOKEN,SUPABASE_SERVICE_KEY, andVALIDATION_ISSUE_GITHUB_TOKEN.env-example-secretwarnings.exclude: ["node_modules"]did not produce a tsconfig no-op exclude finding; the remaining tsconfig finding was the existing empty include warning for**/*.mts.M .gitignoreand?? .kratos/before the smoke.Checklist
Notes for Reviewers
이 PR은 문서 전용입니다. 확인 포인트는 README의 field 이름이 실제
env.ciInjectedKeys/env.optionalLocalKeysschema와 일치하는지, 그리고 key-aware secret 판정 및 tsconfig no-op exclude 설명이 현재 Rust runtime 동작과 어긋나지 않는지입니다.