Skip to content

docs: improve help text for --defaultThemeVariants CLI flag#4154

Open
PKulkoRaccoonGang wants to merge 1 commit intoopenedx:release-23.xfrom
raccoongang:Peter_Kulko/document-default-theme-variants
Open

docs: improve help text for --defaultThemeVariants CLI flag#4154
PKulkoRaccoonGang wants to merge 1 commit intoopenedx:release-23.xfrom
raccoongang:Peter_Kulko/document-default-theme-variants

Conversation

@PKulkoRaccoonGang
Copy link
Contributor

Description

Rewrites the --defaultThemeVariants help text for the build-scss CLI command to explain what the flag actually does, why you'd use it, and what happens to non-default variants

Issue: #3953

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@PKulkoRaccoonGang PKulkoRaccoonGang self-assigned this Mar 4, 2026
@netlify
Copy link

netlify bot commented Mar 4, 2026

👷 Deploy Preview for paragon-openedx-v23 processing.

Name Link
🔨 Latest commit 4c8a4b3
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/69a7fba949f670000898140e

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 4, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/committers-paragon.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

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

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 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.

Details
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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

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

@codecov
Copy link

codecov bot commented Mar 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.39%. Comparing base (dfc69e2) to head (4c8a4b3).
⚠️ Report is 8 commits behind head on release-23.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           release-23.x    #4154   +/-   ##
=============================================
  Coverage         94.39%   94.39%           
=============================================
  Files               242      242           
  Lines              4296     4296           
  Branches           1020      981   -39     
=============================================
  Hits               4055     4055           
  Misses              237      237           
  Partials              4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

3 participants