Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 3.37 KB
Raw

Contributing

Feedback

First off, thank you for considering contributing to the design tokens resolver proposal. Your feedback helps to shape the tooling we provide.

Purpose

These guidelines exist to streamline your experience providing feedback and contributing to the specification.

What contributions are not being requested

The resolver spec does act as a bridge for variations of tokens usage in design tools and their final usage in apps. There are already tools like Stitches and Style Dictionary which are focused on the consumption of resolved tokens. We do not want this proposal to step too far into their territory

Providing Examples for large changes

When proposing large structural changes to the proposal, it's crucial to accompany your suggestions with relevant examples. These examples should demonstrate the proposed changes and their impact on the project.

To provide examples for large changes:

  1. Include comprehensive examples that illustrate the intended modifications. These examples should showcase the proposed design tokens in action and highlight their benefits. Attempt to break your solution or find edge cases to ensure robustness.
  2. Collaborate with other contributors and the community to ensure that these changes would be useful to address their use cases

Providing Feedback for Use Cases

We highly value feedback from users and their use cases. Sharing your experiences, challenges, and suggestions helps us improve the resolver proposal and ensure its effectiveness across various scenarios.

To provide feedback for use cases:

  1. Access the "Issues" section and search for existing use case discussions.
  2. If no relevant discussion exists, create a new issue describing your specific use case and the challenges you've encountered.
  3. Share your feedback, insights, and any suggestions for improving the proposal's implementation.
  4. Engage in conversations with other users and contributors to exchange ideas and gather additional insights.
  5. Consider offering specific examples that illustrate your use case to further enhance the understanding of your feedback.

Code Review and Collaboration

Once you've submitted your proposed changes or feedback, the project maintainers and other contributors will review your contributions. They may offer suggestions, ask questions, or request modifications. Collaborative discussions and code reviews are essential for maintaining the quality and coherence of the proposal.

To collaborate effectively:

  • Respond to feedback promptly and constructively.
  • Engage in discussions, offering further clarifications or justifications where necessary.
  • Be respectful and considerate towards other contributors. = Be open to incorporating constructive feedback and iterating on your contributions.

Submitting Your Contribution

Once your proposed changes or feedback have been reviewed, revised, and approved, it's time to submit your contribution to the Design Tokens proposal.

To submit your contribution:

  • Ensure your branch is up to date with the latest changes from the main repository.
  • Rebase your branch if necessary to incorporate the latest updates.
  • Squash your commits

Community

You can chat with the Tokens Studio team on Slack. This would allow you to interact with like minded design token enthusiasts.