Skip to content

README: tell consumers and their agents to read the guidelines - #1246

Open
Cuervino wants to merge 1 commit into
development/1.0from
improvement/readme-guidelines
Open

Cuervino wants to merge 1 commit into
development/1.0from
improvement/readme-guidelines

Conversation

@Cuervino

@Cuervino Cuervino commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

The guidelines are shipped in the npm package, under stories/, but nothing tells a consumer to read them. A mockup generated by an agent broke three rules that were already written (Toggle in a form with a Save button, delete modal without the resource name, "Done" on a read-only modal).

The README gets a Guidelines section: where the guideline files are in the package, what to read before using a component or building a screen, and a line to add to a project's CLAUDE.md or AGENTS.md, since agents only read the instruction file of the project they work in.

@Cuervino
Cuervino requested a review from a team October 2, 2026 17:39
@bert-e

bert-e commented Oct 2, 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 2, 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 README.md
The package ships the design system guidelines in `stories/`:

- `stories/<Component>/<component>.guideline.mdx`: when and how to use a component. A few older ones sit directly under `stories/`, such as `form.guideline.mdx`.
- The other `.mdx` files directly under `stories/` and under `stories/guideline/`: rules for every screen, such as typography, formats and the design principles in `Introduction.mdx`.

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.

stories/guideline/docs-template.mdx is a blank authoring template ("Component name", "General description"), not a rule, and it ships too. An agent told to read every .mdx under stories/guideline/ will read it as guidance. Exclude it here and in the agent line below, or move it out of stories/guideline/.

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.

2 participants