Esri / calcite-design-system

A monorepo containing the packages for Esri's Calcite Design System
https://developers.arcgis.com/calcite-design-system/
Other
285 stars 76 forks source link

Rework the internal contributing and conventions doc #3818

Closed benelan closed 2 months ago

benelan commented 2 years ago

Description

The goal is to get the internal doc looking like Hub's

  1. I am going to break the conventions into different files by topic so that they can be items in the storybook sidebar like above.

    • Testing
    • Documentation
    • A11y
    • i18n
    • Style
    • Maybe more?
  2. I will audit the existing conventions and remove any that are no longer valid.

  3. Then start beefing up the conventions with unspoken stuff we all just do. If you all think of anything specific that needs to be added to the conventions comment on this issue or edit the description below.

Which Component

NA

Resources

Specific conventions that need to be added (feel free to add more here)

cc @driskull @jcfranco @macandcheese


TODO

jcfranco commented 2 years ago

Jotting some ideas:

geospatialem commented 11 months ago

Related: #7724 - could explore a new patterns documentation page which includes https://github.com/Esri/calcite-design-system/issues/3818#issuecomment-1015996968 and open/close to better serve users.

jcfranco commented 2 months ago

Confirmed w/ @benelan. This is no longer as we've started moving internal doc to our wiki. Closing!