Skip to content

Keep user-visible wording a human-review reason; complete the README summary - #16

Merged
william-gr merged 1 commit into
masterfrom
human-review-wording
Sep 12, 2026
Merged

william-gr merged 1 commit into
masterfrom
human-review-wording

Conversation

@william-gr

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #15, which merged before this landed. Two LOW findings from its own review:

  • review/rubric.md: "comments, docs, or wording changes" as a blanket non-reason would auto-approve product copy in truenas/webui (a relabelled destructive action, a reworded error). Now "wording a user does not see".
  • README.md: the summary of the section claimed to be the full list but omitted the "what can merge" clause, the runtime-only qualifier on dependencies, and the repo-guidelines criterion. It now carries all three and says the rubric is the full list.

No Jira ticket on hand for the title; add one so PR ticket passes.

@william-gr
william-gr merged commit 139685a into master Sep 12, 2026
6 of 7 checks passed
@william-gr
william-gr deleted the human-review-wording branch September 12, 2026 15:39
Comment thread review/rubric.md
- a refactor, rename, or move that keeps behaviour;
- new or extended tests;
- comments, docs, or wording changes;
- comments, docs, or wording a user does not see;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LOW — Narrowing this non-reason to "wording a user does not see" removes user-visible wording from the non-reasons, but it does not make it a reason. The reasons list above is closed — line 111 reads "Answer true only when a line in the diff does one of these" — and none of the seven clauses covers a relabelled destructive action or a reworded error message: clause 1 enumerates API/type/CLI flag/wire format/config key, and clause 4 is a default value or a removed feature, not a string. So a webui PR that renames "Delete" to "Remove" still falls through to line 145's "When unsure, answer false", which is the case the PR description says this change exists to catch.

The intent needs a positive clause in the list above — e.g. "changes wording a user sees where the new wording could mislead: a destructive action's label, a warning, an error message" — rather than only a subtraction from the list below.

Graded LOW rather than MEDIUM: under the amended rubric false is the specified answer, so nothing here contradicts an executable claim; the gap is between the file and the stated goal.

Comment thread README.md
default or removes a feature, deletes or loosens a test, migrates persisted
data, or does what the repo's own review guidelines say a person decides. The
PR description, deferred work, size, refactors, new tests and wording a user
does not see are listed there as non-reasons; the rubric is the full list. `human-review-paths` is the floor under that judgement: it forces

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LOW — This line is ~148 characters; the rest of the paragraph, and the file, wrap at ~76. The rewrite added text mid-paragraph without rewrapping, so the non-reasons sentence and the human-review-paths sentence run together on one line.

Suggested change
does not see are listed there as non-reasons; the rubric is the full list. `human-review-paths` is the floor under that judgement: it forces
does not see are listed there as non-reasons; the rubric is the full list.
`human-review-paths` is the floor under that judgement: it forces

@github-actions

Copy link
Copy Markdown

Two findings: two LOW. A human must look at this one.

Both are docs-only changes, and both are accurate as far as they go: the README summary now carries the "what can merge" clause, the runtime-only qualifier on dependencies and the repo-guidelines criterion, and it says the rubric is the full list, which is what the previous phrasing overclaimed.

LOW — review/rubric.md:138: scoping the non-reason to "wording a user does not see" subtracts user-visible wording from the non-reasons without adding it to the reasons. That list is closed ("Answer true only when a line in the diff does one of these"), and no clause in it fits a relabelled destructive action or a reworded error, so such a PR still lands on "When unsure, answer false". The change needs a positive clause, not only the subtraction. Graded LOW because false remains the answer the amended rubric specifies — the gap is against the stated goal, not against an executable claim.

LOW — README.md:300: the edit left a ~148-character line where the file wraps at ~76; suggestion inline.

A human must look: review/rubric.md:138 changes when the shared review gate withholds approval, and consumers reference this repo at @master, so it changes what can merge in truenas/webui, truenas/api-client-ts, truenas-connect/ui and iXsystems/truenas-ui-components the moment it lands. Whether user-visible wording should demand a person is the judgement call, and it is not one the reviewer should settle for four repos on its own.

Unrelated to the diff: check-ticket is red for the missing Jira reference in the title, as the PR description notes.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Needs a human review. 2 finding(s): 2 LOW.

Nothing blocks, but this change is one a person should decide on:

  • review/rubric.md:138 changes when the shared gate withholds approval; consumers pin @master, so it changes what can merge in four downstream repos on merge

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