Skip to content

Update block integration test docks to make it clear that the helpers can't be used externally#66778

Open
glendaviesnz wants to merge 1 commit intotrunkfrom
update/integration-test-docs
Open

Update block integration test docks to make it clear that the helpers can't be used externally#66778
glendaviesnz wants to merge 1 commit intotrunkfrom
update/integration-test-docs

Conversation

@glendaviesnz
Copy link
Copy Markdown
Contributor

What?

Makes it clear in the docs that the integration test helpers can't currently be used outside of the GB project.

Why?

Currently a custom block developer might think they should be able to follow the example tests in their own code, but this will fail with missing module type errors.

How?

Adds a line to docs to explain private nature of the test helpers.

Testing Instructions

Check the wording

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 6, 2024

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 6, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: glendaviesnz <glendaviesnz@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@glendaviesnz glendaviesnz added the [Type] Developer Documentation Documentation for developers label Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant