Skip to content

New tool contribution guidelines

Anna Gonzales edited this page Jun 27, 2019 · 2 revisions

What is a new tool?

A new tool example would be Sketch, Axure, Adobe XD, Figma, etc. This is not contribution for add-on Sketch libraries.

Phase 1: Internal trial

Requirements:

Assets

  • Component library: parity with Carbon Sketch kit (one theme)
  • Component states
  • Carbon elements
    • color tokens
    • typestyles 
  • Grid template

Documentation

  • About the tool (overview, pros and cons)
  • Getting started documentation 
  • How to use the tool (high level features and organization, etc)

Support

  • Dedicated slack channel
  • Github repo (or tag on carbon-design-kit repo)

Approval

  • Design review
  • Open source ready: No (ok to still have assets behind firewall)

Nice-to-haves:

Assets:

  • Other themes (G10, G90 G100)
  • Carbon elements
    • icons

Phase 2: Public Beta

Requirements

In addition to all the requirements list in Phase 1: internal release

Assets:

  • assets added to public carbon-design-kit repo

Website:

Collaborate with the Carbon team to add website pages.

  • Add documentation content to "Getting started/Designer/new-tool-tab"
  • Direct link to asset downloads (not behind the firewall)
  • Marked as beta

Approval

  • Open source ready: Yes, 100%

Nice-to-haves:

Assets:

  • Other themes (G10, G90 G100)
  • Carbon elements
    • icons

Phase 3: GA

In addition to all the requirements list in Phase 1 and 2

Requirements

Assets

  • Component library: parity with Carbon Sketch kit (all 4 themes)
    • White
    • Gray 10
    • Gray 90
    • Gray 100
  • Carbon elements
    • icons

Nice-to-haves:

  • Cloud distribution process