openedx / brand-openedx

GNU Affero General Public License v3.0
5 stars 115 forks source link

docs: create how to work with design tokens #26

Open dcoa opened 2 months ago

dcoa commented 2 months ago

This PR adds a how-to about design tokens support for the brand package.

There are still details to evaluate such as whether should we install Paragon as a dev dependency and the possible creation of a Paragon CLI command specific to this package.

Any early feedback should be great @brian-smith-tcril and @PKulkoRaccoonGang.

openedx-webhooks commented 2 months ago

Thanks for the pull request, @dcoa!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

:radio_button: Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

:radio_button: Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

:radio_button: Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

mphilbrick211 commented 2 weeks ago

Hi @dcoa! Just checking in on this!

dcoa commented 2 weeks ago

Hi, @mphilbrick211 this is a work in progress I will allocate some time in the following weeks to finish it. Sorry for that.