Artsy's Design System
- Docs: https://palette.artsy.net
- Storybook: https://palette-storybook.artsy.net
- Point People: @dzucconi, @damassi
Palette is a collection of primitive, product-agnostic elements that help encapsulate Artsy's look and feel at base level. This project is intended to be used across our digital product portfolio.
If the component applies to Artsy as a brand and can/will be used across multiple digital products, then Palette is a great place for it. If it's highly product specific then it's best to leave the component where it's used. We can always move things later!
If the above guidance still doesn't give you a good sense of what to do, please join the bi-weekly design systems sync.
If you'd like to add a new component to Palette please create an issue using the component spec template. That'll give both design and engineering a chance to peek at the proposal and provide feedback before moving forward.
In the project root run the following:
$ yarn storybookThis will compile Palette and boot Storybooks, our default development environment.
Other relevant commands are:
$ yarn docs
$ yarn test
$ yarn type-checkFor more info, check out our development guide in the docs.
Palette uses auto-release to automatically release on every PR. Every PR should have a label that matches one of the following
- Version: Trivial
- Version: Patch
- Version: Minor
- Version: Major
- Canary
Major, minor, and patch will cause a new release to be generated. Use major for breaking changes, minor for new non-breaking features, and patch for bug fixes. Trivial will not cause a release and should be used when updating documentation or non-project code.
If you don't want to release on a particular PR but the changes aren't trivial then use the Skip Release tag along side the appropriate version tag.
Canary tags will publish a canary version to NPM which can be used to test work in progress. See the CircleCI job for the exact version published and update your consuming app accordingly.
This project is the work of designers and engineers at Artsy, the world's leading and largest online art marketplace and platform for discovering art. One of our core Engineering Principles is being Open Source by Default which means we strive to share as many details of our work as possible.
You can learn more about this work from our blog and by following @ArtsyOpenSource or explore our public data by checking out our API. If you're interested in a career at Artsy, read through our job postings!