docs(review): Document review rule metadata, severity overrides, and surfaces#121
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
Update ARCHITECTURE.md: §9 now covers RiskFinding, ReviewRuleId::metadata()/all_metadata(), and the post-rule severity-override step; §12 lists review_from_sql / review_from_schema_json with their request/response contract and notes that content mirrors the CLI JSON byte-for-byte.
Add the [review.severity_overrides."<rule-id>"] block to the example config and a dedicated subsection explaining keys, validation, ordering in the pipeline, and the case-by-case rule caveat (risk/drop-pk-or-unique).
… view Bring SKILL.md in sync with the current relune surface: - Configuration block now includes [review] and an example [review.severity_overrides."<rule-id>"] downgrade, with a note that overrides apply post-evaluation. - GitHub Actions section is rewritten to cover both mode: diff and mode: review, including review-only inputs/outputs and a sample workflow that posts a comment then fails on blocking findings. - New "Playground risk review view" subsection points users at the fifth compare-mode view that surfaces CLI review output via WASM.
WasmReviewRequest is annotated with #[serde(rename_all = "camelCase")], so JS callers see beforeSql / exceptRules / severityOverrides etc. Update §12 to match the wire format instead of the Rust field names.
mhiro2
force-pushed
the
docs/review-surfaces
branch
from
May 1, 2026 04:36
a584458 to
3888d94
Compare
Code Metrics Report
Details | | main (62ef818) | #121 (4057abd) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 94.6% | 94.6% | 0.0% |
| Files | 81 | 81 | 0 |
| Lines | 37324 | 37324 | 0 |
| Covered | 35344 | 35344 | 0 |
- | Test Execution Time | 1m28s | 1m32s | +4s |Reported by octocov |
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.
Summary
RiskFinding,ReviewRuleId::metadata()/all_metadata(), and the post-evaluation severity-override step in ARCHITECTURE.md.relune-wasmreview entrypoints (review_from_sql,review_from_schema_json) and their camelCase request / response contract.[review.severity_overrides."<rule-id>"]to the configuration reference, including validation rules and the case-by-case rule caveat.skills/relune/SKILL.mdwith the current review surface — config, GitHub Actionmode: review, and the playground risk review view.Changes
RiskFinding,ReviewRuleId::metadata()/all_metadata(), and the post-rule severity-override step.review_from_sql/review_from_schema_json, including request/response shape and the note that JSON output mirrors the CLI byte-for-byte.[review.severity_overrides."<rule-id>"]to the example config and a dedicated subsection covering keys, validation, pipeline ordering, and therisk/drop-pk-or-uniquecase-by-case caveat (rendered with the> [!NOTE]GitHub alert).[review]and an example[review.severity_overrides."<rule-id>"]downgrade to the configuration block, with a note that overrides apply post-evaluation.mode: diffandmode: review, with review-only inputs/outputs and a sample workflow that comments and then fails on blocking findings.WasmReviewRequestis annotated with#[serde(rename_all = "camelCase")], so update §12 to usebeforeSql/exceptRules/severityOverridesetc. to match the wire format JS callers see.