Conversation
|
✅ Deploy Preview for hpe-theme-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for hpe-design-icons-grommet ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for unrivaled-bublanina-3a9bae ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
does it help if instead of always we use must use Grommet components..
|
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 |
What does this PR do?
This pull request adds detailed Copilot instructions for the HPE Design System monorepo. The new
.github/copilot-instructions.mdfile 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:
.github/copilot-instructions.mdwith an overview of the monorepo structure, listing key workspace roots and packages.Design token and UI conventions:
Pull request and versioning guidelines:
Key file locations:
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?