|
| 1 | +<picture> |
| 2 | + <source media="(prefers-color-scheme: dark)" srcset="https://github.com/hashicorp/design-system/assets/788096/5d6969b7-f8b4-4ad3-9ece-b16b4527522e" width="300"> |
| 3 | + <source media="(prefers-color-scheme: light)" srcset="https://github.com/hashicorp/design-system/assets/788096/8e278094-427f-40cc-912f-9ccd3a0ff879" width="300"> |
| 4 | + <img alt="Helios Design System" src="https://github.com/hashicorp/design-system/assets/788096/8e278094-427f-40cc-912f-9ccd3a0ff879.png" width="300"> |
| 5 | +</picture> |
| 6 | + |
| 7 | +The Helios Design System provides the building blocks to design and implement consistent, accessible, and delightful product experiences across HashiCorp. |
| 8 | + |
| 9 | +## Usage |
| 10 | + |
| 11 | +For guidelines on how to use Helios, see our [documentation website](https://helios.hashicorp.design). |
| 12 | + |
| 13 | +## Release notes |
| 14 | + |
| 15 | +[A changelog for code and Figma changes is kept on the Helios website](https://helios.hashicorp.design/whats-new/release-notes) |
| 16 | + |
| 17 | +## Packages |
| 18 | + |
| 19 | +### `packages/components` [](https://badge.fury.io/js/%40hashicorp%2Fdesign-system-components) |
| 20 | + |
| 21 | +Design System components in Ember.js |
| 22 | + |
| 23 | +- npm package: `@hashicorp/design-system-components` |
| 24 | +- website: [https://helios.hashicorp.design/components](https://helios.hashicorp.design/components) |
| 25 | +- more info: see [components/README](packages/components/README.md) and [components/CONTRIBUTING](packages/components/CONTRIBUTING.md). |
| 26 | + |
| 27 | +### `packages/flight-icons` [](https://badge.fury.io/js/%40hashicorp%2Fflight-icons) |
| 28 | + |
| 29 | +- website: [https://helios.hashicorp.design/icons/library](https://helios.hashicorp.design/icons/library) |
| 30 | + |
| 31 | +Flight icons in different formats (SVG/SVG Sprite/React) |
| 32 | + |
| 33 | +- npm package: `@hashicorp/flight-icons` |
| 34 | +- more info: see [flight-icons/README](packages/flight-icons/README.md) and [flight-icons/CONTRIBUTING](packages/flight-icons/CONTRIBUTING.md) for details on how to use the "sync/build" scripts that export the assets from Figma and generate a bundle of standalone SVG files. |
| 35 | + |
| 36 | +### `packages/tokens` [](https://badge.fury.io/js/%40hashicorp%2Fdesign-system-tokens) |
| 37 | + |
| 38 | +Design tokens |
| 39 | + |
| 40 | +- npm package: `@hashicorp/design-system-tokens` |
| 41 | +- website: [https://helios.hashicorp.design/foundations/tokens](https://helios.hashicorp.design/foundations/tokens) |
| 42 | +- more info: see [tokens/README](packages/tokens/README.md) and [tokens/CONTRIBUTING](packages/tokens/CONTRIBUTING.md) for details on how to update the design tokens. |
| 43 | + |
| 44 | +## Contributing |
| 45 | + |
| 46 | +### Workspaces |
| 47 | + |
| 48 | +This monorepo uses [pnpm workspaces](https://pnpm.io/workspaces) to manage dependencies for all packages. |
| 49 | + |
| 50 | +#### Adding new packages |
| 51 | + |
| 52 | +Run this command from the monorepo root: |
| 53 | + |
| 54 | +```bash |
| 55 | +pnpm -F <workspace-npm-package> add --dev <npm-package> |
| 56 | +``` |
| 57 | + |
| 58 | +e.g. `pnpm -F @hashicorp/design-system-components add --dev ember-cli-flash` |
| 59 | + |
| 60 | +#### Using ember install in the monorepo |
| 61 | + |
| 62 | +Run this command from the monorepo root: |
| 63 | + |
| 64 | +```bash |
| 65 | +pnpm -F <workspace-npm-package> run ember install <npm-package> |
| 66 | +``` |
| 67 | + |
| 68 | +e.g. `pnpm -F @hashicorp/design-system-components run ember install ember-a11y-refocus` |
| 69 | + |
| 70 | +### Changesets |
| 71 | + |
| 72 | +This project uses [changesets](https://github.com/changesets/changesets) to manage how changes will be released. Each user-facing change to a package should come with a changeset for each package that has changed. |
| 73 | + |
| 74 | +To create a changeset, run and follow the prompts in your terminal: |
| 75 | + |
| 76 | +```bash |
| 77 | +pnpm changeset |
| 78 | +``` |
| 79 | + |
| 80 | +See the [changeset docs](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) for more information. |
| 81 | + |
| 82 | +Note: If you want to ignore a changeset bump in terminal (e.g. major bump for selected "package x" is N/A, want a patch release), press return on the command line to skip that step. Press the spacebar to select that step. |
| 83 | + |
| 84 | +## Releasing |
| 85 | + |
| 86 | +See the [release docs](https://hashicorp.atlassian.net/wiki/x/HIBT0Q) for the process we follow to publish a new package version. |
| 87 | + |
| 88 | +## License |
| 89 | + |
| 90 | +This project is licensed under the [Mozilla Public License 2.0](LICENSE). |
| 91 | + |
| 92 | +## Versioning |
| 93 | + |
| 94 | +We use [SemVer](http://semver.org/) for versioning. |
0 commit comments