Add REVIEW.md with automated PR review guidelines - #78
Closed
andypotanin wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a repository-level REVIEW.md intended to be automatically ingested by review agents, capturing repo-specific review policy for the worker-nodejs base image (critical paths, release gates, and conventions).
Changes:
- Added
REVIEW.mddocumenting critical areas (Dockerfile/worker.yaml/permissions) to scrutinize during reviews. - Documented release gating signals (which paths trigger release workflows) and conventions to enforce in CI.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Critical Areas (extra scrutiny) | ||
|
|
||
| - Dockerfile: pinned `NODE_VERSION` / `NPM_VERSION` ARGs (keep pinned), `EXPOSE ${APP_PORT}`, `USER` directive, and the inherited entrypoint contract (`/usr/local/worker/bin/entrypoint.sh` from udx-worker). Do not override ENTRYPOINT. |
Comment on lines
+10
to
+14
| - The Dockerfile `LABEL version` is known to drift from the actual GitVersion-published version; do not treat it as the source of truth, and flag PRs that bump only the label. | ||
|
|
||
| ## Release Model | ||
|
|
||
| - Merge to `latest` cuts a Minor release IF the diff touches `Dockerfile`, `ci/**`, `src/**`, or `LICENSE`. GitVersion is the version source; there is no changelog, so the PR description must state downstream impact (do worker-engine/docker-sftp need FROM-pin bumps?). |
Member
Author
|
Closing: moving this review policy into Devin's own configuration instead of repo files. |
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.
Adds a REVIEW.md instruction file that Devin Review (and other review agents) ingest automatically when analyzing PRs in this repository. It encodes repo-specific review policy: critical paths, release/versioning gates, conventions to enforce, and security expectations.
Docs-only change: no release or deploy workflow matches a root-level REVIEW.md in this repo.