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

Updated installation instructions to emphasize the requirement of a bootstrap.php file. #166

Merged
merged 1 commit into from
Sep 12, 2022
Merged

Updated installation instructions to emphasize the requirement of a bootstrap.php file. #166

merged 1 commit into from
Sep 12, 2022

Conversation

rneudorf-godaddy
Copy link
Contributor

@rneudorf-godaddy rneudorf-godaddy commented Sep 7, 2022

This PR updates README.md to make it clear that setting up a bootstrap.php is a required part of the installation process.

Description of the Change

Issues linked below seem to be caused by excluding WP_Mock::bootstrap(). With the current version of the documentation it can be easy to skip past the requirement to include bootstrap.

This PR also adds examples of using the bootstrap.php file and additional minor layout tweaks.

Closes #128, closes #147

How to test the Change

N/A

Changelog Entry

  • Updated README.md

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

Copy link
Contributor

@wvega-godaddy wvega-godaddy left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@nmolham-godaddy nmolham-godaddy left a comment

Choose a reason for hiding this comment

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

LVGTM

@unfulvio-godaddy unfulvio-godaddy merged commit b3dd966 into 10up:trunk Sep 12, 2022
@unfulvio-godaddy unfulvio-godaddy deleted the update/readme-tweak branch September 12, 2022 15:58
@jeffpaul jeffpaul added this to the 0.5.0 milestone Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants