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

Improve the Compatibility Layer docs to minimise confusion #44924

Merged
merged 3 commits into from Feb 26, 2024

Conversation

kmanijak
Copy link
Contributor

Submission Review Guidelines:

Changes proposed in this Pull Request:

The current wording may create a confusion that Single Product block disables Compatibility Layer as probably seen in the comment in Announcing the Product Collection Block post.

This PR improves the description and distinguishes blocks representing classic templates vs other blocks.

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

No testing needed.

Changelog entry

  • Automatically create a changelog entry from the details below.

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Comment

@kmanijak kmanijak added focus: documentation Issues and PRs related to improving documentation category: extensibility team: Kirigami & Origami labels Feb 23, 2024
@woocommercebot woocommercebot requested review from a team and ObliviousHarmony and removed request for a team February 23, 2024 13:42
@github-actions github-actions bot removed the focus: documentation Issues and PRs related to improving documentation label Feb 23, 2024
Copy link
Contributor

Hi @ObliviousHarmony,

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

@github-actions github-actions bot added the plugin: woocommerce Issues related to the WooCommerce Core plugin. label Feb 23, 2024
Copy link
Contributor

Test Results Summary

Commit SHA: 62d63d1

Test 🧪Passed ✅Failed 🚨Broken 🚧Skipped ⏭️Unknown ❔Total 📊Duration ⏱️
API Tests25900202610m 38s
E2E Tests2210012303448m 26s

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
Contributor

@ObliviousHarmony ObliviousHarmony left a comment

Choose a reason for hiding this comment

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

Having reviewed this PR with no idea what the compatibility layer was, this was pretty clear 😄

@kmanijak kmanijak merged commit 4b69fc7 into trunk Feb 26, 2024
56 checks passed
@kmanijak kmanijak deleted the docs/improve-compatibility-layer-description branch February 26, 2024 08:03
@github-actions github-actions bot added this to the 8.8.0 milestone Feb 26, 2024
@github-actions github-actions bot added the needs: analysis Indicates if the PR requires a PR testing scrub session. label Feb 26, 2024
@alopezari alopezari added status: analysis complete Indicates if a PR has been analysed by Solaris and removed needs: analysis Indicates if the PR requires a PR testing scrub session. labels Feb 26, 2024
Konamiman pushed a commit that referenced this pull request Mar 13, 2024
* Improve the Compatibility Layer docs to avoid confusion

* Add changelog

* Add punctuation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: extensibility plugin: woocommerce Issues related to the WooCommerce Core plugin. status: analysis complete Indicates if a PR has been analysed by Solaris team: Kirigami & Origami
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants