Giter VIP home page Giter VIP logo

canvas-tokens's Introduction

canvas-tokens's People

Contributors

alanbsmith avatar dependabot[bot] avatar jaclynjessup avatar nicholasboll avatar rayredgoose avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

canvas-tokens's Issues

Proposal: Make build command more flexible

๐Ÿš€ Feature Proposal

Now style dictionary builds all files for all platforms at the same time, but we can make this build separated for each platform, language and token level.

Motivation

It will allow us to update only changed files instead of all.

Acceptance Criteria

  • Command to generate files for a specific platform
  • Command to generate files for a specific extension
  • Command to generate files for a specific token level

[Spike] Restructure Styling Docs IA

๐Ÿ” Spike

Canvas Kit Styling is bigger than we originally anticipated. It feels like it doesn't fit well in our current Storybook IA. This spike should help us answer:

  • Where should styling documentation live?
  • How should it be structured?
  • What content should be covered?
    • What are we currently missing?

Deliverable

Make a recommendation to the team on where Canvas Styling documentation should live, what content it should include, and how it should be structured.

SPIKE Mobile Tokens Package(s)

๐Ÿ” Spike

Mobile is looking to use our tokens package. We need to explore how we would build our tokens for Android & iOS comsumption

Questions

What are the requirements for Mobile?
What format do they need to ingest our tokens?
Can we make a new package canvas-tokens-mobile or do we need canvas-tokens-[andoid/ios] ?

Documentation

Create a plan on how we will release canvas-tokens-[mobile]

Add System Color and Breakpoint Tokens

๐Ÿš€ Feature Proposal

Launch an alpha release of the new system color tokens

Motivation

provide early access to the new system color tokens

Acceptance Criteria

  • Add new system color tokens
  • release an alpha

Fix release script

๐Ÿ› Bug Report

Expected Behavior

Actual Behavior

Steps to Reproduce

Spike: Identify what actions we need for canvas-tokens

๐Ÿ” Spike

Find CK actions that can be reused by canvas-tokens and how we need to change them to be able to reuse.

Possible actions:

  • forward merge
  • release to be composite
  • major / minor release

Questions

  • What action do we need to have for canvas-tokens?
  • What actions from CK and CKA can we reuse?
  • How do we need to change these actions?

Add consumer documentation

๐Ÿš€ Feature Proposal

Add documentation to help consumers understand how to use our token packages in their applications.

Motivation

Good documentation makes it easier for consumers to use our tokens.

Acceptance Criteria

Add documentation for:

  • Installation
  • Using CSS packages (CSS, Sass, and LESS)
  • Using JS / TS packages

Create Token Migration Guide

๐Ÿ’ก Suggestion

Developers need a guide to help them migrate from our old tokens in @workday/canvas-kit-react/tokens to @workday/canvas-tokens-web. Let's create a discussion for it.

Combine parser and sync scripts

๐Ÿ’ก Suggestion

Token parser and sync script are both doing filtering and initial transform of tokens.
We need to validate if it's possible to combine them or have stricter understanding what they doing.

Motivation

It will make code base more understandable and cleaner.

Add pull request automation

๐Ÿš€ Feature Proposal

Add GitHub actions for pull request automation

Motivation

Run tests in CI to make sure everything is good before merging.

Acceptance Criteria

  • Add a GitHub action to run tests for pull requests

Proposal: Add lint-pull-request action

๐Ÿš€ Feature Proposal

Add the next actions:

  • lint-pull-request: to validate pull request title and structure (CKA action)
  • new-issue: to add issue to backlog (third part action)

Motivation

Acceptance Criteria

Improve developer experience

๐Ÿ’ก Suggestion

We need to make a handful of developer-focused improvements to make canvas-tokens-web easier to use.

  • Move CSS, SCSS, and LESS directories out of dist.
    • This will allow devs to import CSS from @workday/canvas-tokens-web/css/_variables.css instead of /dist.
  • #41
    • This will improve intellisense and typeahead support.
  • Add JSDoc to describe token values. E.g. 2rem (32px) for space.x8.
    • This will improve intellisense and typeahead support.

Motivation

Helping developers transition to the new tokens will reduce frustration.

Add static types to JS objects.

๐Ÿš€ Feature Proposal

Add as const to *.d.ts files

Motivation

This will enable static parsing of styles as well as better type ahead support

Canvas Tokens Web initial release

๐Ÿ’ก Suggestion

Publish our first version of @workday/canvas-tokens-web

Motivation

Let's get an initial release of Canvas Tokens Web out so we can test what works and what doesn't.

Add publishing infrastructure

๐Ÿš€ Feature Proposal

Add infrastructure to publish our tokens to npm and tag releases.

Motivation

CI / CD actions reduce opportunities for error and the cost of maintaining our tokens.

Acceptance Criteria

  • Add a release action to publish tokens and add a git tag.
  • Update the Maintainer doc with information about the release process

Fix base color and opacity tokens

๐Ÿ› Bug Report

Summary

The hex values for pomegranate 200 and berry smoothie 200 are incorrect.
Opacity 400 and 500 also need to be adjusted.

Add Storybook

๐Ÿš€ Feature Proposal

Add Storybook for @workday/canvas-tokens-web.

Motivation

Storybook allows us to organize and understand the output of our token transformations. It also creates an environment for our visual regression tests.

Acceptance Criteria

  • Add Storybook integration
  • Add a build step to generate a static Storybook for GitHub Pages
  • Update the Maintainer doc to include how to run Storybook locally.

New PR template to match Canvas Kit one

๐Ÿš€ Feature Proposal

Update our current PR template to match that we have in Canvas Kit

Motivation

We need a consistency across Canvas repos to have opportunity to use sharable GH actions

Proposal: Add forward merge action

๐Ÿš€ Feature Proposal

Add forward merge action as we have for canvas-kit repo

Motivation

It will be easier to keep branches up to date.

Add missing color tokens

๐Ÿš€ Feature Proposal

  • Update system.color.bg.muted.soft (licorice.200)
  • Add system.color.bg.muted.softer (licorice.100)
  • Add system.color.bg.alt.softer (soap.100)
  • Add system.color.border.input.inverse (soap.300)
  • Add system.color.fg.muted.soft (licorice.200)
  • Add system.color.static.gold.stronger (toastedMarshmallow.600)
  • Add system.color.text.primary.stronger (blueberry.600)

Set up visual tests

๐Ÿš€ Feature Proposal

Set up visual regression tests with Chromatic. This is dependent on #1.

Motivation

Visual regression tests will help us make sure we don't unintentionally break something while updating our tokens.

Acceptance Criteria

  • Set up Chromatic
  • Add a PR check to run tests and verify
  • Update the Testing section of the Maintainer doc

Update release action

๐Ÿ› Bug Report

The GitHub release action takes an incorrect changeset body to generate a release changelog

Expected Behavior

Changeset body is the same that we have for packages.

Actual Behavior

Use non modified text.

Steps to Reproduce

Web Release Action;

  • Create Release Step

The commonjs path is incorrect

๐Ÿ› Bug Report

The canvas-tokens-web package.json references "commonjs" while the path is "common-js". This causes Jest tests to fail on a module resolution error.

Update the PR GH actions

๐Ÿš€ Feature Proposal

We need PR check action to be similar to what we have in CK.

Motivation

Acceptance Criteria

Action validates:

  • PR body contains summary, category
  • PR has correct name
  • Unit tests
  • Visual tests

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.