diff --git a/.eslintignore b/.eslintignore index a719533e5c..b08f6bfbd8 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,10 +1,4 @@ coverage/ dist/ +lib/ node_modules/ - -# packages that have lib as the output -packages/digest/lib -packages/perf-test/lib -packages/playground/lib -packages/react-theming/lib - diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b5cb5e7199..5cee003198 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,8 @@ -CONTRIBUTING -============ +# CONTRIBUTING - - [Getting started](#getting-started) - [Useful Commands](#useful-commands) - [Workflow](#workflow) @@ -31,7 +29,7 @@ You can contribute to Stardust by being an official [contributor](setup-local-de ### Useful Commands ->This list contains the most useful commands. You should run `yarn run` to see all scripts. +> This list contains the most useful commands. You should run `yarn run` to see all scripts. ```sh yarn start // run doc site @@ -66,7 +64,7 @@ These guides will walk your through various activities for contributing: ## Accessibility -Stardust implements accessibility using accessibility behaviors. The behaviors add attributes to the DOM elements (mainly role and aria-* properties) as well as handle keyboard interaction and focus. Every accessible component has a default behavior, which can be overriden using the `accessibility` prop. You can choose a behavior from the ones provided by Stardust or you can implement a new behavior. +Stardust implements accessibility using accessibility behaviors. The behaviors add attributes to the DOM elements (mainly role and aria-\* properties) as well as handle keyboard interaction and focus. Every accessible component has a default behavior, which can be overriden using the `accessibility` prop. You can choose a behavior from the ones provided by Stardust or you can implement a new behavior. Behaviors apply properties, focus handling and keyboard handlers to the component slots. When developing a component, the properties and keyboard handlers need to be spread to the corresponding slots. @@ -83,13 +81,15 @@ ARIA [roles][3] and [attributes][4] provide necessary semantics for assistive te In addition to behaviors, ARIA [landmarks][5] and [naming props][6] need to be added to the components/elements to form the page structure and provide textual information. For example, to make an icon-only Button accessible, `aria-label` prop needs to be used: + ```html -