openedx / openedx/paragon

Design tokens improvement

Open
#3,057 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

design tokens
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

To make working with design tokens easier in the future, it would be great to add a few helpers:

  1. Set up a linter to validate the formatting of files containing design tokens (tokens folder).

  2. Script for checking CSS variables declaration.
    Previously, when using SCSS variables, if the SCSS variable was not declared but was used, we could see an error during assembly and fix this problem. When using CSS variables, if the variable is used in Paragon components and has been deleted, we will not know about it. Thus, the browser is the only tool for validating variable declarations, which is not very convenient.

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the design-token files in tokens/src and the current CSS variable usage described in the issue. Done means adding formatting validation for token files and a script that detects CSS variables used by Paragon components but missing from declarations.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, scss
Domain
design, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.