Reading a review
What owndiff posts on a pull request and what it means.
owndiff posts one summary comment on each pull request and keeps it up to date on new commits. It also sets an owndiff check run and, when something needs attention, a label.
Verdicts
| Verdict | Check run conclusion | Label | Meaning |
|---|---|---|---|
| Aligned | success | none | The change matches what the product should do. |
| Needs decision | action required | owndiff: needs decision | The change makes a product decision nobody has recorded. |
| Breaks rules | failure | owndiff: breaks rules | The change breaks a business rule from your docs or rules. |
There are no scores. A finding quotes the source it relies on: a rule file, a doc, the pull request description or a linked issue. Not recorded has no source, because nothing records the decision.
Findings
| Finding | Meaning |
|---|---|
| Breaks a rule | The code contradicts a written rule. |
| Not recorded | The change decides something about the product without a record. |
| Requirement not fully delivered | The pull request claims a requirement the code only partly delivers. |
| Out of scope | The change adds behavior your docs or rules place outside the project's scope. |
A finding marked Not recorded is settled by recording the decision in owndiff. The summary on the pull request updates and the decision is kept for later reviews.
Checks from .owndiff/
Every file with check: true that matches the change gets its own check run, owndiff / <title>. With conclusion: failure it can block a merge through branch protection. See the .owndiff/ folder.
When owndiff doesn't review
- Draft pull requests wait until they are marked ready, unless
triggers.skipDraftsisfalse. - With
triggers.modeset totag_only, pull requests without theowndifflabel are skipped. - Authors in
triggers.excludeAuthorsare skipped. - A pull request above the project's diff limit (3,000 changed lines by default) gets a short note instead of a review. Files in
ignoredon't count toward the limit.