Skip to content

improvement(guidelines): voice, tone and vocabulary rules for interface text - #1260

Merged
bert-e merged 3 commits into
development/1.0from
improvement/voice-and-tone-guideline
Oct 19, 2026
Merged

bert-e merged 3 commits into
development/1.0from
improvement/voice-and-tone-guideline

Conversation

@Cuervino

Copy link
Copy Markdown
Contributor

Started from a review comment on identity-ui #249, where "Choose another name" read as too authoritative. core-ui had no rule on how interface text addresses the user, so neither a developer nor an agent could choose the wording.

What the page adds

Style/Content gets two sections, above the existing Placeholder section (moved down, unchanged):

  • Voice and tone: point of view, statement and action, actions, failures, conditional effects, please and sorry, confirmations and success messages, inline validation, progress text, dynamic values, long forms, punctuation.
  • Vocabulary: one verb per action, verb meanings, states, technical vocabulary.

Examples are shown as Write / Not tables. Two of them use real components, a confirmation modal and two fields in error, in stories/content.stories.tsx (hidden from the sidebar).

How the rules were checked

The draft was given, with no other context, to an agent asked to rewrite about 35 real strings from three UIs: identity-ui, the Data Browser and the Maestro console. Each place where it had to guess became a rule or a precision. Most counter-examples come from those UIs, made generic.

Not in this PR

CUI-72.

@Cuervino
Cuervino requested a review from a team October 16, 2026 18:08
@bert-e

bert-e commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Hello cuervino,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options
name description privileged authored
/after_pull_request Wait for the given pull request id to be merged before continuing with the current one.
/bypass_author_approval Bypass the pull request author's approval ⭐
/bypass_build_status Bypass the build and test status ⭐
/bypass_commit_size Bypass the check on the size of the changeset TBA ⭐
/bypass_incompatible_branch Bypass the check on the source branch prefix ⭐
/bypass_jira_check Bypass the Jira issue check ⭐
/bypass_peer_approval Bypass the pull request peers' approval ⭐
/bypass_leader_approval Bypass the pull request leaders' approval ⭐
/bypass_source_branch_lineage Bypass the cross-branch contamination check ⭐
/approve Instruct Bert-E that the author has approved the pull request. ✍️
/create_pull_requests Allow the creation of integration pull requests.
/create_integration_branches Allow the creation of integration branches.
/no_octopus Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
/unanimity Change review acceptance criteria from one reviewer at least to all reviewers
/wait Instruct Bert-E not to run until further notice.
Available commands
name description privileged
/help Print Bert-E's manual in the pull request.
/status Print Bert-E's current status in the pull request.
/clear Remove all comments from Bert-E from the history TBA
/retry Re-start a fresh build TBA
/build Re-start a fresh build TBA
/force_reset Delete integration branches & pull requests, and restart merge process from the beginning.
/reset Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

@bert-e

bert-e commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

Comment thread stories/content.mdx Outdated
Comment thread stories/content.mdx Outdated
| Write | Not |
| --- | --- |
| Select an LDAP provider to load preset configurations. | Choose your LDAP provider to load preset configurations. |
| Enter the encryption key | Enter your encryption key |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The section says it covers helper text, but this row has no period, unlike line 97. That breaks the Punctuation rule at line 226. Add the period, or say this is a title (line 91).

Suggested change
| Enter the encryption key | Enter your encryption key |
| Enter the encryption key. | Enter your encryption key. |

@eve-scality

eve-scality commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

⚠️ No verdict

A critical part of the review could not be assessed, so no verdict was reached.

Findings

  • ⚠️ Add a test that renders the modal open and checks its title, body, and button labels

  • ⚠️ Add a test that renders ValidationMessages and asserts both error strings are visible

Full review

Findings

  • ⚠️ Add a test that renders the modal open and checks its title, body, and button labels
    stories/content.stories.tsx:13
    The ConfirmationModal story (line 13) initialises isOpen at false (line 15), so the Modal component starts hidden. The story is the live example of the confirmation pattern on the guidelines page. If a future refactor breaks how Modal consumes isOpen, title, close, or actions, the guidelines page will silently show a broken or non-interactive example — but nothing in the suite would catch it. No unit test renders this story with the modal open and verifies that the title 'Download new connection details for "prod-paris"?', the body text 'The connection details downloaded before will stop working.', and the confirm label 'Download' are all present. Until such a test exists, the wiring from these props to visible output is entirely unprotected.
    Suggestion: Render ConfirmationModal with isOpen forced to true — either by wrapping the story render function with a controlled prop or by triggering the button click — then assert that the modal title, the body sentence, the cancel button, and the 'Download' confirm button are visible in the document. This gives a test that would fail the moment any of those prop connections breaks.
  • ⚠️ Add a test that renders ValidationMessages and asserts both error strings are visible
    stories/content.stories.tsx:44
    The ValidationMessages story (line 44) passes error="Enter a rule name." and helpErrorPosition="bottom" to the first FormGroup (lines 53–54), and error="The number of days must be at least 1." with the same position to the second (lines 61–62). These props are the mechanism by which the guidelines page demonstrates inline validation. If a refactor changes how FormGroup renders or positions its error prop — for instance, a rename or a prop type change — the example will silently show fields without any error text. No unit test currently renders this story and checks that both error strings appear in the output. A regression would go undetected until someone noticed the guidelines page looked wrong.
    Suggestion: Render ValidationMessages and assert that the text 'Enter a rule name.' and 'The number of days must be at least 1.' are both present in the document. That is the minimum check that would catch the error-prop wiring breaking on either field.

Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@bert-e

bert-e commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

Comment thread stories/content.mdx
| | Button | Confirmation | Notification |
| --- | --- | --- | --- |
| Write | Delete Group | Delete Group "Billing team" permanently? | Group "Billing team" deleted. |
| Not | Delete Group | Remove Group "Billing team" permanently? | |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The write-not-rows CSS paints the whole "Not" row red. That includes the "Delete Group" button cell, which is correct and the same as the "Write" row. A reader skimming the table may think "Delete Group" is a bad label. Leave that cell empty and add a :empty { background: transparent; } rule for write-not-rows, as line 15 does for write-not.

Suggested change
| Not | Delete Group | Remove Group "Billing team" permanently? | |
| Not | | Remove Group "Billing team" permanently? | |

Comment thread stories/content.mdx

| Write | Not |
| --- | --- |
| 1 user updated | 1 users updated |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This success message has no period. That breaks the Punctuation rule (line 226) and does not match the other success examples, such as Group "Billing team" deleted.

Suggested change
| 1 user updated | 1 users updated |
| 1 user updated. | 1 users updated. |

@Cuervino

Copy link
Copy Markdown
Contributor Author

/approve

@bert-e

bert-e commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

  • ✔️ development/1.0

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

  • Any commit you add on the source branch will trigger a new cycle after the
    current queue is merged.
  • Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: approve

@bert-e

bert-e commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

I have successfully merged the changeset of this pull request
into targetted development branches:

  • ✔️ development/1.0

Please check the status of the associated issue None.

Goodbye cuervino.

@bert-e
bert-e merged commit c4db8ee into development/1.0 Oct 19, 2026
8 of 9 checks passed
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.

4 participants