Skip to content

[Monorepo] Copilot instructions - Added initial instructions#5841

Open
halocline wants to merge 8 commits intomasterfrom
factory
Open

[Monorepo] Copilot instructions - Added initial instructions#5841
halocline wants to merge 8 commits intomasterfrom
factory

Conversation

@halocline
Copy link
Collaborator

What does this PR do?

This pull request adds detailed Copilot instructions for the HPE Design System monorepo. The new .github/copilot-instructions.md file provides comprehensive documentation on the project structure, development workflows, design token architecture, UI conventions, and pull request guidelines, making it easier for contributors and Copilot to understand and work within the repo.

Documentation additions:

  • Added .github/copilot-instructions.md with an overview of the monorepo structure, listing key workspace roots and packages.
  • Documented essential development commands, including workspace builds, Storybook launches, and test execution.
  • Provided step-by-step instructions for adding component pages to the docs site, including file locations and required patterns.

Design token and UI conventions:

  • Explained the design token architecture, build process, and Figma sync commands, covering token layers and variant handling.
  • Outlined UI framework conventions, theming, icon usage, and static export configuration for the docs site.

Pull request and versioning guidelines:

  • Clarified branch naming, PR title/description formatting, and linking issues in PRs.
  • Detailed versioning and publishing processes using Changesets and workspace catalogs.

Key file locations:

  • Listed important

What are the relevant issues?

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

Screenshots (if appropriate)

Should this PR be mentioned in Design System updates?

Is this change backwards compatible or is it a breaking change?

@changeset-bot
Copy link

changeset-bot bot commented Feb 21, 2026

⚠️ No Changeset found

Latest commit: e55e772

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

@netlify
Copy link

netlify bot commented Feb 21, 2026

Deploy Preview for hpe-theme-preview ready!

Name Link
🔨 Latest commit e55e772
🔍 Latest deploy log https://app.netlify.com/projects/hpe-theme-preview/deploys/699c689a063cd5000813345d
😎 Deploy Preview https://deploy-preview-5841--hpe-theme-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@halocline halocline requested a review from Copilot February 21, 2026 17:47
@netlify
Copy link

netlify bot commented Feb 21, 2026

Deploy Preview for hpe-design-icons-grommet ready!

Name Link
🔨 Latest commit e55e772
🔍 Latest deploy log https://app.netlify.com/projects/hpe-design-icons-grommet/deploys/699c689a21f59d0008fa910e
😎 Deploy Preview https://deploy-preview-5841--hpe-design-icons-grommet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@halocline halocline added the Owner:Development Used in issues that are being worked on/should be worked on by a developer. label Feb 21, 2026
@netlify
Copy link

netlify bot commented Feb 21, 2026

Deploy Preview for unrivaled-bublanina-3a9bae ready!

Name Link
🔨 Latest commit e55e772
🔍 Latest deploy log https://app.netlify.com/projects/unrivaled-bublanina-3a9bae/deploys/699c689a2131e900087d092d
😎 Deploy Preview https://deploy-preview-5841--unrivaled-bublanina-3a9bae.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an initial .github/copilot-instructions.md document to help contributors (and Copilot) navigate the HPE Design System monorepo, including repo structure, common workflows, token architecture, and PR/versioning conventions.

Changes:

  • Introduces a comprehensive Copilot instructions markdown file under .github/.
  • Documents key workspaces/packages, essential pnpm commands, and docs-authoring conventions.
  • Summarizes design token layering/sync workflow and repo PR/versioning guidelines.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

halocline and others added 2 commits February 21, 2026 10:51
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

## UI Framework Conventions

- **Always use Grommet components** (`Box`, `Button`, `Text`, etc. from `grommet`) — not custom HTML elements.
Copy link
Collaborator

Choose a reason for hiding this comment

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

does it help if instead of always we use must use Grommet components..

@britt6612
Copy link
Collaborator

This looks so far so good as a start Im sure we can expand on it as we build more with it. couple things that came to mind that we dont need to address now was maybe adding any formatting rules. Maybe for TS avoid using any unless unavoidable, Prefer functional components with arrow syntax.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Owner:Development Used in issues that are being worked on/should be worked on by a developer.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants