message: chore: update guidelines
diff: @@ -11,43 +11,20 @@ on the docs website.
  Every component package must implement the following:
  -- `docs/`
  - - [component].api.md
  - - [component].aria.md
  - - readme.md: This is the main website docs
  -- `stories/`
  - - basic.stories.tsx
  - - advanced.stories.tsx
  - `src/`
  +
  + - `tests/`
  + - [component].test.tsx: Write tests for the components here.
  - [component].hook.tsx (optional): Any amazing hook that's local to this
  component.
  - [component].utils.tsx (optional): Any utility that's local to this component
  - [component].tsx: Base component that consumes the hook.
  -- `test/`
  - - utils.test.tsx
  - - hooks.test.tsx
  - - component.test.tsx
  - - accessbility.test.tsx
  + - [component].stories.tsx: Write stories for components here
  +
  - `types/` : For adding custom types for 3rd party packages
  - `README.md`: A basic guideline for this package, installation guide,
  contribution guide, and sample examples.
  -### Docs / Components API
  -
  -- filename: `[component].api.md`
  -- purpose: document your ideas for this component's API and usage examples. You
  - can also link to existing libraries written in either jQuery, React, Vue,
  - vanilla JavaScript.
  -
  -### Docs / Aria Guidelines
  -
  -- filename: `[component].aria.md`
  -- purpose: This is where you write out the accessibility requirements and html
  - structure for this component. You can also link to existing accessibility
  - guidelines or website.
  -
  -> Ensure you exclude all the `*.notes.md, *.aria.md`, in tsconfig.json
  -
  ## Code Guidelines
  - Write small functions, and compose them: Resist the urge to write a complex
  @@ -60,7 +37,7 @@ Every component package must implement the following:
  - Ensure you add a jsDoc comment for each type definition
  -- TypeScript: Component prop types should be named with `[compoonent]Props`
  +- TypeScript: Component prop types should be named with `[component]Props`
  - Ensure you update the component dependencies, anytime you import a chakra
  component
  