Skip to content

docs(readme): audit 신호 정책 문서화#111

Merged
JeremyDev87 merged 1 commit into
masterfrom
feature/106-audit-signal-docs
May 6, 2026
Merged

docs(readme): audit 신호 정책 문서화#111
JeremyDev87 merged 1 commit into
masterfrom
feature/106-audit-signal-docs

Conversation

@JeremyDev87

Copy link
Copy Markdown
Owner

Summary

audit signal quality 개선 이슈의 최종 사용자-facing 계약을 README에 문서화했습니다.

Related Issues

Changes Made

Testing

  • git diff --check
  • cargo metadata --format-version 1 --no-deps
  • cargo test -p maximus-core
  • cargo test -p maximus-cli
  • cargo test -p maximus-checks --test env_checks --test tsconfig_checks
  • npm test
  • node --test test/installed-native-runtime.test.js
  • cargo run -p maximus-cli -- audit /Users/pjw/workspace/io/orbit-dashboard --only env,tsconfig --fail-on none
  • fresh-session Devil's Advocate review: Critical 0 / High 0 / Medium 0 / Low 0

Contract Impact

  • CLI contract status: stable
  • Rust-direct evidence: cargo run -p maximus-cli -- audit /Users/pjw/workspace/io/orbit-dashboard --only env,tsconfig --fail-on none
  • Smoke result: duplicate env key NEXT_PUBLIC_OKTA_MOCK remains an error.
  • Smoke result: env-example-secret warnings remain for token/service-key style keys such as AI_READINESS_INGEST_TOKEN, GH_COLLECTOR_TOKEN, GITHUB_TOKEN, RMBR_CCP_TELEMETRY_TOKEN, SUPABASE_SERVICE_KEY, and VALIDATION_ISSUE_GITHUB_TOKEN.
  • Smoke result: public/client/repo/url style values did not appear as env-example-secret warnings.
  • Smoke result: exclude: ["node_modules"] did not produce a tsconfig no-op exclude finding; the remaining tsconfig finding was the existing empty include warning for **/*.mts.
  • Target repo status before and after smoke was unchanged. It already had M .gitignore and ?? .kratos/ before the smoke.

Checklist

  • The change is scoped and focused
  • Tests were added or updated when behavior changed
  • Documentation was updated if needed
  • No destructive automatic fix was introduced without clear justification

Notes for Reviewers

이 PR은 문서 전용입니다. 확인 포인트는 README의 field 이름이 실제 env.ciInjectedKeys / env.optionalLocalKeys schema와 일치하는지, 그리고 key-aware secret 판정 및 tsconfig no-op exclude 설명이 현재 Rust runtime 동작과 어긋나지 않는지입니다.

README에 env secret heuristic, env config schema, tsconfig noise policy를 추가한다.

Closes #106
@JeremyDev87 JeremyDev87 self-assigned this May 6, 2026
@JeremyDev87 JeremyDev87 added the documentation Improvements or additions to documentation label May 6, 2026
@JeremyDev87 JeremyDev87 marked this pull request as ready for review May 6, 2026 14:27
@JeremyDev87 JeremyDev87 marked this pull request as draft May 6, 2026 14:29
@JeremyDev87 JeremyDev87 marked this pull request as ready for review May 6, 2026 14:31
@JeremyDev87

Copy link
Copy Markdown
Owner Author

독립 fresh-session 리뷰 결과

  • Verdict: APPROVE
  • Severity Summary: Critical 0 / High 0 / Medium 0 / Low 0
  • Findings: 없음
  • Rationale: 변경 범위는 README.md, README.en.md의 audit signal 정책 문서화로 한정되어 있고, 문서의 env secret 분류, env-missing-concrete exact-key 제외, unknown config field parse error, tsconfig no-op exclude 설명이 현재 구현 및 검증 결과와 일치합니다. 로컬 검증과 GitHub check 모두 실패 없이 통과했습니다.

참고: GitHub 정책상 self-authored PR에는 공식 approve review를 제출할 수 없어, 동일한 독립 리뷰 verdict를 PR comment로 게시합니다.

@JeremyDev87 JeremyDev87 marked this pull request as draft May 6, 2026 14:32
@JeremyDev87 JeremyDev87 marked this pull request as ready for review May 6, 2026 14:33
@JeremyDev87 JeremyDev87 merged commit 87c2a12 into master May 6, 2026
43 checks passed
@JeremyDev87 JeremyDev87 deleted the feature/106-audit-signal-docs branch May 6, 2026 14:33
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Maximus] audit signal quality docs 및 orbit-dashboard smoke 계약 추가

1 participant