Closed Bug 1127427 Opened 9 years ago Closed 6 years ago

[gaia-color-picker] add tests and package the color-picker component up correctly

Categories

(Firefox OS Graveyard :: Gaia::Components, defect)

x86
macOS
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: djf, Unassigned)

References

Details

Bug 1123829 introduced a gaia-color-picker component. This is a followup to add tests and package the component up in a way that conforms with what we're doing for the other components.  A TODO list from Wilson is below.

I created the initial color picker component, but am unlikely to have the time to tackle this bug soon. So anyone who wants to take it should fee free.

REPO STRUCTURE

Could you conform to the repo structure of the other gaia-components. Each repo should have a working /index.html served from a gh-pages branch.

The README.md should link to the demo and provide at minimum install instructions, and if you have time brief API overview.

TESTS

This looks like a very complicated component, that really needs tests. Checkout gaia-header [1] as an example of how to author tests and have them run on commit against Travis.

GAIA-COMPONENT BASE CLASS

You don't have to use the base class, but it's good if you can. The class works around some gaps in the platform (such as shadow-dom css selectors) and provides: a way of keeping attributes and properties in sync, RTL 'dirchange' callbacks, optimizations. It's nice that we can target bugs in one place.

As the platform improves gaia-component.js will become lighter, but it's unlikely to disappear. With web-components APIs being so low-level, I feel we need something like this to make sure we have consistency across all our components. This makes us look more professional and it's helpful for authors and users.

PACKAGE DEFINITION

It's important that you provide a package JSON definition. This should come in the form of bower.json or package.json (but ideally both). At the bare minimum these files should provide a 'name', 'version' and 'main'. Again use gaia-header as a template for this.

VERSIONING

You need to version (semver) your component using git tags whenever anything changes. If you don't users/package-managers won't know when your package has changed, or when you have introduced breaking changes. `bower version patch | minor | major` makes this very easy.
Depends on: 1123829
Depends on: 1127460
No longer depends on: 1127460
Firefox OS is not being worked on
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.