diff --git a/src/_about/contributing/add-a-component-or-pattern-once-approved.html b/src/_about/contributing/add-a-component-or-pattern-once-approved.html index 386954091..625ca22a0 100644 --- a/src/_about/contributing/add-a-component-or-pattern-once-approved.html +++ b/src/_about/contributing/add-a-component-or-pattern-once-approved.html @@ -8,25 +8,50 @@
  • -

    Add the component or pattern

    +

    Contribute to the Design System yourself

    - Create a pull request in GitHub in order to add your component or pattern: + If your team has the resources to contribute your component or pattern to the Design System, you can complete much of the work on your own.

      -
    1. Go to src/_components/ or src/_patterns/ depending upon which you intend to add. +
    2. Comment on your experimental design ticket to indicate that you will be contributing your component or pattern yourself. This avoids any duplication of effort between your team and the Design System Team.
      3. +
    3. Add the component or pattern to the Design System repo. +
        +
      1. Go to src/_components/ or src/_patterns/ depending upon which you intend to add. +
        2. +
      2. Open the Add file menu
        3. +
      3. Copy the contents of the component or pattern template and fill in the sections as best you can. See the guidance on documenting your component or pattern. Don't worry: The Design System Team will review and ask questions about your contribution to help provide the best possible documentation.
        4. +
      4. When you're ready, commit the changes to a branch, and create a pull request for peer review.
        5. +
      5. After your pull request has been created, assign it to {{ site.experimental_reviewer_1 }} to review and merge your request.
        6. +
      4. -
    4. Open the Add file menu
      5. -
    5. Copy the contents of the component or pattern template and fill in the sections as best you can. Don't worry: The Design System Team will review and ask questions about your contribution to help provide the best possible documentation.
      6. -
    6. When you're ready, commit the changes to a branch, and create a pull request for peer review.
      7. -
    7. After your pull request has been created, assign it to {{ site.experimental_reviewer_1 }} to review and merge your request.
    +
  • -

    Document your component or pattern

    +

    Contribute to the Design System via the Design System Team

    +

    + If your team does not have the resources to contribute your component or pattern to the Design System, the Design System Team will complete the work on your behalf. They will: +

    +
      +
    1. Review your supporting research.
      2. +
    2. Add your component or pattern to the team’s backlog and begin working on it when able to do so.
      3. +
    3. Contact you for supporting documentation. This may include: +
        +
      1. A link to the research in the Research repo
        2. +
      2. Any guidance updates that you recommend
        3. +
      3. Figma artifacts
        4. +
      4. Code
        5. +
      +
      4. +
    4. Complete preparation of the component or pattern, including a Collaboration Cycle Staging Review.
      5. +
    +
    • +
  • +

    Document your component or pattern

    Your documentation should follow the component or pattern template to the best of your ability. Any sections you have trouble filling out simply leave a "TODO:" note for the Design System Team who will review your submission and make edits or ask you questions, as necessary.

    -

    Artifacts (mockups, wireframes, or prototypes)

    +

    Artifacts (mockups, wireframes, or prototypes)