Repository navigation
Add REVIEW.md with project review guidelines - #43
devin-ai-integration[bot] wants to merge 2 commits into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
…fault review Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
|
Superseded by #44. #44 moves these criteria to Closing without merging. |



Summary
Adds a root
REVIEW.md. Devin Review picks it up automatically (**/REVIEW.md) and uses it to add TIG project requirements on top of its full default review. The file tells the reviewer to run the complete default review first (correctness, bugs, security, performance, style, and so on) and not to narrow or replace it. The three project requirements below are extra checks on top of that. Each one gets a verdict in a separate "Project Requirements" section of the review, and the normal findings are reported as usual alongside it.Documentation parity (blocking). Lists what counts as user-facing in this repo: tig-cli options, config keys and env vars, image contents and tags,
demo-*.sh, calibration scripts,examples/, and install requirements. It maps each area to the docs that must be updated:tig-cli/README.md,terrain-intelligence-generator/README.md,docs/demos/*,docs/reference/*, example READMEs, and skills. A user-facing change without the matching doc updates is a Fail, and the reviewer requests changes.Broad deployability. Flags:
Verdicts are Pass, Concern (friction that doesn't block the PR), or Fail.
Test coverage. A fix needs a regression test for the exact condition that triggered the bug. New capability needs both nominal and off-nominal tests. Weakened assertions are a red flag, and new tests must actually run in CI (the reviewer checks workflow
paths:filters). The file also maps each area of the code to where its tests should live:tig-cli/tests, thetest-*-image.shscripts, or the product and regression scripts.Link to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/1643b4aad36f48d3b7b1617bd58b9f20
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/1643b4aad36f48d3b7b1617bd58b9f20?variant=devin