Skip to content

Guidelines: no full uppercase text, punctuation by sentence or fragment (CUI-73) - #1263

Open
Cuervino wants to merge 4 commits into
development/1.0from
improvement/CUI-73-uppercase-and-punctuation
Open

Cuervino wants to merge 4 commits into
development/1.0from
improvement/CUI-73-uppercase-and-punctuation

Conversation

@Cuervino

Copy link
Copy Markdown
Contributor

Jira: CUI-73

Two gaps found while reviewing a dashboard page against the Style/Content guideline.

  • Typography, Sentence case: no full uppercase style, an acronym keeps its capitals.
  • Content, Punctuation: a sentence ends with a period whatever component holds it, a fragment does not, and a list keeps one form. The previous rule put a period after any tooltip, including a formula or a noun phrase.

@bert-e

bert-e commented Oct 20, 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.

@Cuervino
Cuervino requested a review from a team October 20, 2026 17:41
@bert-e

bert-e commented Oct 20, 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:

@eve-scality

Copy link
Copy Markdown
Contributor

ℹ️ No review performed

No test review was performed: no code under test could be determined: the pull request changes no code and no tests.

Comment thread stories/typography.mdx
Comment thread stories/content.mdx Outdated
Comment thread stories/content.mdx
Comment thread stories/content.mdx
Comment thread stories/content.mdx
Comment thread stories/typography.mdx
Exception: when displaying a list of resources (buckets, nodes, accounts…), each item may be capitalized as a proper noun if it represents a named entity.

This rule is enforced by the `technical-sentence-case` ESLint rule.
Do not use a full uppercase style. An uppercase label is harder to read than the same label in sentence case. An acronym keeps its capitals, such as S3, LDAP or URL.

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.

Storybook itself breaks this new rule: the captions in stories/Toggle/toggle.stories.tsx:91, stories/guideline/responsive.stories.tsx:23 and stories/guideline/selection-controls-overview.stories.tsx:21 use textTransform: 'uppercase'. Drop the uppercase style there so the docs follow the rule they state.

This branch has not been deployed

No deployments
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.

3 participants