Skip to content

Add "Testing Vue components" section to Vue styleguide

Tom Quirk requested to merge tomquirk-master-patch-50394 into master

What does this MR do?

We currently don't have a SSoT of style guidelines for testing Vue.

This MR:

  • Adds a new section to our Vue style guide, "Testing Vue Components"
    • Add guidelines for some low-hanging fruit:
      • createComponent factory
      • accessing props
      • ... others (please suggest/contribute!)
  • Adds a link to this new section in the main Vue guide

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcia Ramos

Merge request reports