Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TourKit README to correct primaryButton example and formatting #37427

Merged
merged 1 commit into from Mar 27, 2023

Conversation

mattsherman
Copy link
Contributor

All Submissions:

Changes proposed in this Pull Request:

This PR makes two small changes to the TourKit README...

  • Correct primaryButton config in example code
  • Improve formatting of example code (fix indentation)

How to test the changes in this Pull Request:

  1. Verify example for primaryButton is correct (see Show spotlight when switching to variable product type #37413 for an example of code)
  2. Verify example formatting is improved (indentation).

Other information:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you created a changelog file for each project being changed, ie pnpm --filter=<project> changelog add?
  • Have you included testing instructions?

FOR PR REVIEWER ONLY:

  • I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

@mattsherman mattsherman added focus: documentation Issues and PRs related to improving documentation type: technical debt This issue/PR represents/solves the technical debt of the project. package: @woocommerce/components issues related to @woocommerce/components labels Mar 24, 2023
@mattsherman mattsherman requested review from chihsuan and a team March 24, 2023 14:57
@mattsherman mattsherman self-assigned this Mar 24, 2023
@github-actions
Copy link
Contributor

Hi @chihsuan, @woocommerce/mothra

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

@mattsherman mattsherman marked this pull request as ready for review March 24, 2023 14:58
@github-actions
Copy link
Contributor

Test Results Summary

Commit SHA: 5ec5d74

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests25900202610m 49s
E2E Tests1910010020116m 36s

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

Copy link
Member

@chihsuan chihsuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM! 💯

@mattsherman mattsherman merged commit de111c1 into trunk Mar 27, 2023
21 of 22 checks passed
@mattsherman mattsherman deleted the fix/tour-kit-documentation branch March 27, 2023 11:09
@github-actions github-actions bot added this to the 7.7.0 milestone Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: documentation Issues and PRs related to improving documentation package: @woocommerce/components issues related to @woocommerce/components type: technical debt This issue/PR represents/solves the technical debt of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants