Contrib.social

Explain project goals in README / homepage

Open on Drupal.org →
Created on 18 April 2025, 18 days ago

Problem/Motivation

The Design Tokens project doesn't currently explain its goals and purpose. Like all open source projects, it will want contributors to collaborate with. This can't happen if the goals are unclear.

Steps to reproduce

  1. Look at homepage.
  2. Look for README.
  3. Find no info.
  4. Try to read the code to glean some goals.
  5. Remember that we are all trying our best and let go of my frustration so I can collaborate and help others. ❤️‍🩹
  6. Create an issue and offer to collaborate and help others.

Proposed resolution

Add docs explaining:

  • Why design tokens are important to component libraries. Not many front-end developers are aware of the importance of design tokens.
  • Which specification is being used to define design tokens. The default_config/open-props.tokens.json implies that the Design Tokens Format Module is being used.
  • Explain how integrating design tokens into Drupal's PHP codebase would be beneficial. (I actually haven't thought about this before; I've only thought about CSS/JS integration which is pretty straightforward and I'd love to hear your thoughts.)

Remaining tasks

  • Write some preliminary docs.
  • Commit the docs.
  • Keep them up-to-date.
📌 Task
Status

Active

Component

Documentation

Created by

🇹🇼Taiwan johnalbin Taipei, Taiwan

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024