Skip to content

Add REVIEW.md with project review guidelines - #43

Closed
devin-ai-integration[bot] wants to merge 2 commits into
developfrom
devin/1790713887-review-md
Closed

devin-ai-integration[bot] wants to merge 2 commits into
developfrom
devin/1790713887-review-md

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

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.

  1. 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.

  2. Broad deployability. Flags:

    • hard-coded site specifics
    • credentials or access only one organization has
    • code that only works with one container runtime or one platform
    • heavy infrastructure made mandatory in core paths (Kubernetes, Airflow, MinIO)
    • behavior locked to one mission
    • niche required dependencies

    Verdicts are Pass, Concern (friction that doesn't block the PR), or Fail.

  3. 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, the test-*-image.sh scripts, 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


Devin Review

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Devin Review: 1 flag

Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)

Devin Review

…fault review

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@sonarqubecloud

Copy link
Copy Markdown

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

Superseded by #44.

#44 moves these criteria to .github/project-requirements/criteria.md and uses them only in a dedicated Project Requirements PR gate. It skips the root REVIEW.md because Devin Review automatically applies any **/REVIEW.md to every general review. The three requirements carry over unchanged. Only the scope intro and the reporting section were reworded for the gate.

Closing without merging.

Written by Devin

@devin-ai-integration
devin-ai-integration Bot deleted the devin/1790713887-review-md branch October 7, 2026 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant