Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

About

Suggest an addition or update

Follow the steps below to suggest a component or pattern for the design system through our experimental process.

New component or pattern

  • Check the design system and the backlog

    Be sure to check the design system and ensure your component or pattern does not already exist. If your addition overlaps with a current component or pattern, be sure to call that out when you file your request in step 2.

    Check the backlog to see if your idea has already been suggested. If you do not see your idea in the backlog, go to step 2.

    Check the backlog

    If you do see your idea in the backlog, message the contributors to see if they are moving forward or not. If not, and you would like to tackle the problem, move forward with step 2.

  • Fill out a request

    Fill out an Experimental Design System request issue. This should take no more than 10-15 minutes. In the issue you will need to provide justification for this new component or pattern, and link to any artifacts you want to include.

    Request a new addition to the Design System

    If you feel the addition is small and well explained in your issue, then you may request an asynchronous review.

    After filling out the issue, post in the #platform-design-system slack channel and tag Carol Wong to alert the team that you have filled out an issue and would like to get on the council's agenda.

    Note that you do not need to have anything coded at this point, and in fact, we suggest not having anything coded since ideally ideas would be surfaced to the council before teams put effort into building new components.

    Additionally, the artifacts you include do not need to be high fidelity. They only need to be able to illustrate your concept. We do, however, encourage some thoughts on how your component or pattern works on mobile.

  • Present to Design System Council

    You will present your work to the Design System Council at an upcoming meeting (unless you have requested an asynchronous review). The Design System Council meets every other Thursday at 11am Eastern. Experimental design requests will always be prioritized in this meeting, and teams can assume generally that they will be able to present the same week of the request. In order to kick off this step:

    • Submit a request to join an upcoming Design System Council meeting in #platform-design-system.
    • During the meeting, the Design System Council will evaluate the request and make a decision.

    If your component or pattern request is rejected, the council will add notes as to why and what they suggest you do instead in the issue.

  • Asynchronous review

    If you feel like the change is simple and does not need further explanation beyond what you have provided in your issue then you may ask to have asynchronous approval when creating the initial request.

    • Your addition will still be discussed in the council meeting, but you do not have to attend.
    • The Design System Council may still request additional information from you in order to properly handle your request.

    Update an existing component or pattern

    If you are suggesting a change to something that already exists in the VA.gov Design System, you should go through the New component or pattern process above.

    Minor changes

    If you are requesting a minor change, a change which you feel would be a minor adjustment to current functionality, then you may request an asynchronous review. To do so, complete steps 1 and 2 above and indicate in your request that you would like an asynchronous review by the Design System Council.

    Bugs

    If the change you are requesting is a bug in a component or pattern file an issue. For example, if the behavior of the component does not match our documentation or a component is not behaving as expected. If the Design System Team feels the matter needs to be addressed by the Design System Council, we'll let you know in the issue.

    Update documentation

    For requesting more documentation or updating a piece of documentation on design.va.gov, please fill out a documentation request.

    Edit this page in GitHub (Permissions required)
    Last updated: May 16, 2024