Deploy preview for PR 2641 🛫

Author: joyenjoyer

pr-preview/pr-2641/docs/contributing-getting-started.json

@@ -1 +1 @@
-{"description":"\n## Contributing\n\nContributions are welcome! If you want to submit a change you will need to open a pull request on Github. To do so first fork the repository to your own Github account.\n\n### What can you contribute?\n\nIf you found a bug or want to add a minor feature, go ahead! If you'd like to add a new component, or change/add new visuals, please read on.\n\nWe try to keep InstUI easy to use, easy to learn and free from bloat.\nFor this reason we will only add new components if it fits into the current design patterns, and the new component cannot be\nconstructed from the existing ones. For these reasons adding a new component has the following process:\n\n- You should write a document which includes the component description, and the use cases it's meant to be used in.\n- You should make some kind of design sketch that documents the design of the component (e.g. with [Figma](https://www.figma.com/)).\n- Our design team will review and approve this design sketch.\n- If the sketch is OK, you will need to make a pull request (read on for our code guidelines), the InstUI dev team, the design team, and our a11y team will review and merge your contribution.\n\n### Building InstUI from the source\n\nPlease follow the steps on the [how to build guide page](building-and-running-instui).\n\n### Running the documentation app\n\n1. Run `pnpm start`\n1. Open [http://localhost:9090](http://localhost:9090) in your browser\n\n### Development\n\n1. Run `pnpm run build:watch` to build all of the packages for a development environment and watch for changes.\n1. Run `pnpm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:9090](http://localhost:9090) in a browser. When you make changes to the source code you should see the page auto-reload.\n1. Run `pnpm run test:watch -- --filter @instructure/[package name]` to run the tests for 'package name' and watch for changes.\n1. Run `pnpm run test` to run all the tests for every package.\n\n## Code guidelines\n\n### Testing\n\nSee the [testing documentation](testing-overview) for details.\n\n### Linters and Code Formatting\n\nLinters are run as part of the build. If you use VSCode, you can set up the following plugins to catch lint and formatting errors earlier.\n\n1. Install the _Eslint_ plugin [VSCode](https://github.com/Microsoft/vscode-eslint)\n1. Install the _Stylelint_ plugin [VSCode](https://github.com/stylelint/vscode-stylelint)\n1. Run `pnpm install` to install the dependencies\n1. Restart your editor\n\n### Documentation\n\nPlease update the documentation and examples with any changes.\n\n- `pnpm start` will build the production version of the documentation. You can view it at [http://localhost:9090](http://localhost:9090).\n- All components and utilities should be well documented, including examples.\n- Write documentation inline in code comment blocks. The code and docs should\n  always be in sync.\n\n### Commit Guidelines\n\nRun `git commit` to commit your changes and follow our commit message format.\n\n### Registering the components Theme type\n\n1. Add the component theme type (`export type MyComponentTheme = {}`) in `packages/shared-types/src/ComponentThemeVariables.ts`.\n2. Add this new type to the `ThemeVariables` map in the same file (this is needed for the theme overrides to be typed well).\n3. When naming the theme for a subcomponent (e.g.: `MyComponent > Item`), prefix the name with its parent's name, e.g.: `MyComponentItemTheme`. In the `ThemeVariables`, register it both under its prefixed name (`MyComponentItem`) and under its componentId as well (`MyComponent.Item`).\n\n### Accessibility and Internationalization Requirements\n\nAll components should:\n\n1. Be accessible (See the [accessibility requirements](accessibility) for more information).\n1. Support RTL languages.\n1. Localize all dates, times, numbers and strings (or require localized content passed in via props).\n","title":"Getting Started","category":"Contributing","order":1,"relativePath":"docs/contributing/contributing-getting-started.md","extension":".md","srcPath":"docs/contributing/contributing-getting-started.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/contributing/contributing-getting-started","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/contributing/contributing-getting-started.md').default","esPath":"@instructure/docs/contributing/contributing-getting-started","themePath":"docs/contributing/contributing-getting-started.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","id":"contributing-getting-started"}
+{"description":"\n## Contributing\n\nContributions are welcome! If you want to submit a change you will need to open a pull request on Github. To do so first fork the repository to your own Github account.\n\n### What can you contribute?\n\nIf you found a bug or want to add a minor feature, go ahead! If you'd like to add a new component, or change/add new visuals, please read on.\n\nWe try to keep InstUI easy to use, easy to learn and free from bloat.\nFor this reason we will only add new components if it fits into the current design patterns, and the new component cannot be\nconstructed from the existing ones. For these reasons adding a new component has the following process:\n\n- You should write a document which includes the component description, and the use cases it's meant to be used in.\n- You should make some kind of design sketch that documents the design of the component (e.g. with [Figma](https://www.figma.com/)).\n- Our design team will review and approve this design sketch.\n- If the sketch is OK, you will need to make a pull request (read on for our code guidelines), the InstUI dev team, the design team, and our a11y team will review and merge your contribution.\n\n### Building InstUI from the source\n\nPlease follow the steps on the [how to build guide page](building-and-running-instui).\n\n### Running the documentation app\n\n1. Run `pnpm start`\n1. Open [http://localhost:9090](http://localhost:9090) in your browser\n\n### Development\n\n1. Run `pnpm run build:watch` to build all of the packages for a development environment and watch for changes.\n1. Run `pnpm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:9090](http://localhost:9090) in a browser. When you make changes to the source code you should see the page auto-reload.\n1. Run `pnpm run test:watch -- --filter @instructure/[package name]` to run the tests for 'package name' and watch for changes.\n1. Run `pnpm run test` to run all the tests for every package.\n\n## Code guidelines\n\n### Testing\n\nSee the [testing documentation](testing-overview) for details.\n\n### Linters and Code Formatting\n\nLinting is run as part of the build via [oxlint](https://oxc.rs/docs/guide/usage/linter).\n\nUseful commands:\n\n- `pnpm run lint` — lint the whole workspace.\n- `pnpm run lint:fix` — lint the whole workspace and auto-fix what it can.\n- `pnpm run lint:changes` — lint only files changed since the last commit.\n- `pnpm --filter <package name> lint` / `lint:fix` — lint a single package.\n\nLint errors are also fixed automatically on commit for staged files via `lint-staged` (see the `pre-commit` git hook).\n\nIf you use VSCode, you can set up the following plugin to catch lint errors earlier.\n\n1. Install the _Oxc_ plugin [VSCode](https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode)\n1. Run `pnpm install` to install the dependencies\n1. Restart your editor\n\n### Documentation\n\nPlease update the documentation and examples with any changes.\n\n- `pnpm start` will build the production version of the documentation. You can view it at [http://localhost:9090](http://localhost:9090).\n- All components and utilities should be well documented, including examples.\n- Write documentation inline in code comment blocks. The code and docs should\n  always be in sync.\n\n### Commit Guidelines\n\nRun `git commit` to commit your changes and follow our commit message format.\n\n### Registering the components Theme type\n\n1. Add the component theme type (`export type MyComponentTheme = {}`) in `packages/shared-types/src/ComponentThemeVariables.ts`.\n2. Add this new type to the `ThemeVariables` map in the same file (this is needed for the theme overrides to be typed well).\n3. When naming the theme for a subcomponent (e.g.: `MyComponent > Item`), prefix the name with its parent's name, e.g.: `MyComponentItemTheme`. In the `ThemeVariables`, register it both under its prefixed name (`MyComponentItem`) and under its componentId as well (`MyComponent.Item`).\n\n### Accessibility and Internationalization Requirements\n\nAll components should:\n\n1. Be accessible (See the [accessibility requirements](accessibility) for more information).\n1. Support RTL languages.\n1. Localize all dates, times, numbers and strings (or require localized content passed in via props).\n","title":"Getting Started","category":"Contributing","order":1,"relativePath":"docs/contributing/contributing-getting-started.md","extension":".md","srcPath":"docs/contributing/contributing-getting-started.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/contributing/contributing-getting-started","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/contributing/contributing-getting-started.md').default","esPath":"@instructure/docs/contributing/contributing-getting-started","themePath":"docs/contributing/contributing-getting-started.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","id":"contributing-getting-started"}

pr-preview/pr-2641/docs/v11_6/contributing-getting-started.json

@@ -1 +1 @@
-{"description":"\n## Contributing\n\nContributions are welcome! If you want to submit a change you will need to open a pull request on Github. To do so first fork the repository to your own Github account.\n\n### What can you contribute?\n\nIf you found a bug or want to add a minor feature, go ahead! If you'd like to add a new component, or change/add new visuals, please read on.\n\nWe try to keep InstUI easy to use, easy to learn and free from bloat.\nFor this reason we will only add new components if it fits into the current design patterns, and the new component cannot be\nconstructed from the existing ones. For these reasons adding a new component has the following process:\n\n- You should write a document which includes the component description, and the use cases it's meant to be used in.\n- You should make some kind of design sketch that documents the design of the component (e.g. with [Figma](https://www.figma.com/)).\n- Our design team will review and approve this design sketch.\n- If the sketch is OK, you will need to make a pull request (read on for our code guidelines), the InstUI dev team, the design team, and our a11y team will review and merge your contribution.\n\n### Building InstUI from the source\n\nPlease follow the steps on the [how to build guide page](building-and-running-instui).\n\n### Running the documentation app\n\n1. Run `pnpm start`\n1. Open [http://localhost:9090](http://localhost:9090) in your browser\n\n### Development\n\n1. Run `pnpm run build:watch` to build all of the packages for a development environment and watch for changes.\n1. Run `pnpm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:9090](http://localhost:9090) in a browser. When you make changes to the source code you should see the page auto-reload.\n1. Run `pnpm run test:watch -- --filter @instructure/[package name]` to run the tests for 'package name' and watch for changes.\n1. Run `pnpm run test` to run all the tests for every package.\n\n## Code guidelines\n\n### Testing\n\nSee the [testing documentation](testing-overview) for details.\n\n### Linters and Code Formatting\n\nLinters are run as part of the build. If you use VSCode, you can set up the following plugins to catch lint and formatting errors earlier.\n\n1. Install the _Eslint_ plugin [VSCode](https://github.com/Microsoft/vscode-eslint)\n1. Install the _Stylelint_ plugin [VSCode](https://github.com/stylelint/vscode-stylelint)\n1. Run `pnpm install` to install the dependencies\n1. Restart your editor\n\n### Documentation\n\nPlease update the documentation and examples with any changes.\n\n- `pnpm start` will build the production version of the documentation. You can view it at [http://localhost:9090](http://localhost:9090).\n- All components and utilities should be well documented, including examples.\n- Write documentation inline in code comment blocks. The code and docs should\n  always be in sync.\n\n### Commit Guidelines\n\nRun `git commit` to commit your changes and follow our commit message format.\n\n### Registering the components Theme type\n\n1. Add the component theme type (`export type MyComponentTheme = {}`) in `packages/shared-types/src/ComponentThemeVariables.ts`.\n2. Add this new type to the `ThemeVariables` map in the same file (this is needed for the theme overrides to be typed well).\n3. When naming the theme for a subcomponent (e.g.: `MyComponent > Item`), prefix the name with its parent's name, e.g.: `MyComponentItemTheme`. In the `ThemeVariables`, register it both under its prefixed name (`MyComponentItem`) and under its componentId as well (`MyComponent.Item`).\n\n### Accessibility and Internationalization Requirements\n\nAll components should:\n\n1. Be accessible (See the [accessibility requirements](accessibility) for more information).\n1. Support RTL languages.\n1. Localize all dates, times, numbers and strings (or require localized content passed in via props).\n","title":"Getting Started","category":"Contributing","order":1,"relativePath":"docs/contributing/contributing-getting-started.md","extension":".md","srcPath":"docs/contributing/contributing-getting-started.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/contributing/contributing-getting-started","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/contributing/contributing-getting-started.md').default","esPath":"@instructure/docs/contributing/contributing-getting-started","themePath":"docs/contributing/contributing-getting-started.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","id":"contributing-getting-started"}
+{"description":"\n## Contributing\n\nContributions are welcome! If you want to submit a change you will need to open a pull request on Github. To do so first fork the repository to your own Github account.\n\n### What can you contribute?\n\nIf you found a bug or want to add a minor feature, go ahead! If you'd like to add a new component, or change/add new visuals, please read on.\n\nWe try to keep InstUI easy to use, easy to learn and free from bloat.\nFor this reason we will only add new components if it fits into the current design patterns, and the new component cannot be\nconstructed from the existing ones. For these reasons adding a new component has the following process:\n\n- You should write a document which includes the component description, and the use cases it's meant to be used in.\n- You should make some kind of design sketch that documents the design of the component (e.g. with [Figma](https://www.figma.com/)).\n- Our design team will review and approve this design sketch.\n- If the sketch is OK, you will need to make a pull request (read on for our code guidelines), the InstUI dev team, the design team, and our a11y team will review and merge your contribution.\n\n### Building InstUI from the source\n\nPlease follow the steps on the [how to build guide page](building-and-running-instui).\n\n### Running the documentation app\n\n1. Run `pnpm start`\n1. Open [http://localhost:9090](http://localhost:9090) in your browser\n\n### Development\n\n1. Run `pnpm run build:watch` to build all of the packages for a development environment and watch for changes.\n1. Run `pnpm run dev` to start the dev server to run/develop examples and documentation. You can then visit [http://localhost:9090](http://localhost:9090) in a browser. When you make changes to the source code you should see the page auto-reload.\n1. Run `pnpm run test:watch -- --filter @instructure/[package name]` to run the tests for 'package name' and watch for changes.\n1. Run `pnpm run test` to run all the tests for every package.\n\n## Code guidelines\n\n### Testing\n\nSee the [testing documentation](testing-overview) for details.\n\n### Linters and Code Formatting\n\nLinting is run as part of the build via [oxlint](https://oxc.rs/docs/guide/usage/linter).\n\nUseful commands:\n\n- `pnpm run lint` — lint the whole workspace.\n- `pnpm run lint:fix` — lint the whole workspace and auto-fix what it can.\n- `pnpm run lint:changes` — lint only files changed since the last commit.\n- `pnpm --filter <package name> lint` / `lint:fix` — lint a single package.\n\nLint errors are also fixed automatically on commit for staged files via `lint-staged` (see the `pre-commit` git hook).\n\nIf you use VSCode, you can set up the following plugin to catch lint errors earlier.\n\n1. Install the _Oxc_ plugin [VSCode](https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode)\n1. Run `pnpm install` to install the dependencies\n1. Restart your editor\n\n### Documentation\n\nPlease update the documentation and examples with any changes.\n\n- `pnpm start` will build the production version of the documentation. You can view it at [http://localhost:9090](http://localhost:9090).\n- All components and utilities should be well documented, including examples.\n- Write documentation inline in code comment blocks. The code and docs should\n  always be in sync.\n\n### Commit Guidelines\n\nRun `git commit` to commit your changes and follow our commit message format.\n\n### Registering the components Theme type\n\n1. Add the component theme type (`export type MyComponentTheme = {}`) in `packages/shared-types/src/ComponentThemeVariables.ts`.\n2. Add this new type to the `ThemeVariables` map in the same file (this is needed for the theme overrides to be typed well).\n3. When naming the theme for a subcomponent (e.g.: `MyComponent > Item`), prefix the name with its parent's name, e.g.: `MyComponentItemTheme`. In the `ThemeVariables`, register it both under its prefixed name (`MyComponentItem`) and under its componentId as well (`MyComponent.Item`).\n\n### Accessibility and Internationalization Requirements\n\nAll components should:\n\n1. Be accessible (See the [accessibility requirements](accessibility) for more information).\n1. Support RTL languages.\n1. Localize all dates, times, numbers and strings (or require localized content passed in via props).\n","title":"Getting Started","category":"Contributing","order":1,"relativePath":"docs/contributing/contributing-getting-started.md","extension":".md","srcPath":"docs/contributing/contributing-getting-started.md","srcUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","packageName":"@instructure/docs","requirePath":"@instructure/docs/contributing/contributing-getting-started","requireStr":"require('/home/runner/work/instructure-ui/instructure-ui/docs/contributing/contributing-getting-started.md').default","esPath":"@instructure/docs/contributing/contributing-getting-started","themePath":"docs/contributing/contributing-getting-started.md","themeUrl":"https://github.com/instructure/instructure-ui/tree/master/docs/contributing/contributing-getting-started.md","id":"contributing-getting-started"}