New issue
Advanced search Search tips

Issue 851288 link

Starred by 2 users

Issue metadata

Status: Assigned
Owner:
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Bug



Sign in to add a comment

Make ChopsUI follow best practies for a shared library

Project Member Reported by zhangtiff@chromium.org, Jun 10 2018

Issue description

Right now, while we're developing ChopsUI, it's okay for us to regularly release breaking versions or add new elements. ChopsUI is still very new, and we're in that stage where we're sort of figuring the basics out.

However, before we start having these elements used more broadly, we will need to establish clearer communication on the state of our elements. Some examples: 

- We should explicitly state on chopsui-gallery whether the elements are stable, unstable, etc. At the very moment I would call the elements "untable, pre-release, use at our own risk". 
- We should establish standards that new elements should meet before being published in ChopsUI. This will be useful since over time people will want to add their own elements and ChopsUI will be supporting these elements. Eventually, I want the presence of an element in ChopsUI to represent an endorsement from us that the element is stable and safe to use.  
- Long-term, we should consider having a tiered system where new proposed elements could go into an experimental package before being moved to the main ChopsUI package. 
- We should use semvers so that our versions tell people if there are breaking changes. 
 
Here's a useful page with some best practices for making shared web components: https://github.com/webcomponents/gold-standard/wiki 

Sign in to add a comment