Skip to content

Add size prop naming guidelines - #8291

Open
joshblack wants to merge 2 commits into
docs/add-variant-naming-docsfrom
docs/add-size-naming-docs
Open

Add size prop naming guidelines#8291
joshblack wants to merge 2 commits into
docs/add-variant-naming-docsfrom
docs/add-size-naming-docs

Conversation

@joshblack

@joshblack joshblack commented Aug 11, 2026

Copy link
Copy Markdown
Member

Part of github/primer#6732

This PR updates our component prop naming guidance with the canonical size prop conventions from the API audit.

Changelog

New

  • Add guidance for named and numeric size props.

Changed

Removed

  • None.

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; this updates internal skill documentation and has no public-facing impact.

Closes github/primer#6732

This PR updates our component prop naming guidance with the canonical size prop conventions from the API audit.

### Changelog

#### New

- Add guidance for named and numeric size props.

#### Changed

- Document small, medium, and large as our standard named scale, with medium as the default.

#### Removed

- None.

### Rollout strategy

- [ ] Patch release
- [ ] Minor release
- [ ] Major release; if selected, include a written rollout or migration plan
- [x] None; this updates internal skill documentation and has no public-facing impact.

### Testing & Reviewing

Review the guidance against the component size audit in github/primer#6732.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 340f1c08-6adb-4055-a220-52a750204d3b
@changeset-bot

changeset-bot Bot commented Aug 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: e38c930

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joshblack joshblack added the skip changeset This change does not need a changelog label Aug 11, 2026
@github-actions github-actions Bot added staff Author is a staff member integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Aug 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Action required

👋 Hi, this pull request contains changes to the source code that github/github-ui depends on. If you are GitHub staff, test these changes with github/github-ui using the integration workflow. Check the integration testing docs for step-by-step instructions. Or, apply the integration-tests: skipped manually label to skip these checks.

@joshblack joshblack added the integration-tests: skipped manually Changes in this PR do not require an integration test label Aug 11, 2026
@joshblack
joshblack marked this pull request as ready for review August 11, 2026 17:57
Copilot AI lite review requested due to automatic review settings August 11, 2026 17:57
@joshblack
joshblack requested a review from a team as a code owner August 11, 2026 17:57
@joshblack
joshblack requested a review from siddharthkp August 11, 2026 17:57

Copilot AI left a comment

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.

Pull request overview

This PR updates the internal style-guide documentation for component prop naming by adding canonical guidance for when and how to use a size prop, aligning with the API audit conventions.

Changes:

  • Adds a new section recommending size (not variant) for visual scale.
  • Defines the standard named size scale (small/medium/large, defaulting to medium) and when to extend to xsmall/xlarge.
  • Documents when numeric sizes are appropriate (e.g., avatars/icons needing precise dimensions).
Show a summary per file
File Description
.github/skills/style-guide/docs/component-prop-naming.md Adds size prop naming conventions, including named scale guidance and numeric-size guidance.

Review details

Tip

Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

@github-actions
github-actions Bot requested a deployment to storybook-preview-8291 August 11, 2026 18:00 Abandoned
@github-actions
github-actions Bot requested a deployment to storybook-preview-8291 August 11, 2026 18:14 Abandoned
@joshblack
joshblack force-pushed the docs/add-size-naming-docs branch from e38c930 to 4471a3d Compare August 11, 2026 20:19
@github-actions
github-actions Bot requested a deployment to storybook-preview-8291 August 11, 2026 20:22 Abandoned
@github-actions
github-actions Bot temporarily deployed to storybook-preview-8291 August 11, 2026 20:32 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm integration-tests: skipped manually Changes in this PR do not require an integration test skip changeset This change does not need a changelog staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants