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 Setup instructions with prerequisites #516

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

juanmaguitar
Copy link

@juanmaguitar juanmaguitar commented May 7, 2024

When running yarn setup:tools for the first time after cloning the repo locally, some errors may appear if composer update is not run first.

A specific PHP version is also a requirement that is not properly remarked on the README.md

See #514

This PR propose a solution to tackle these issues and improve the contribution experience for first-timers.

@@ -12,7 +12,7 @@
"@wordpress/env": "9.2.0"
},
"scripts": {
"setup:tools": "yarn && composer install && TEXTDOMAIN=wporg composer exec update-configs && composer --working-dir=./source/wp-content/plugins/phpdoc-parser install",
Copy link
Contributor

Choose a reason for hiding this comment

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

Not critic, but you would be running this command twice
TEXTDOMAIN=wporg composer exec update-configs

Copy link
Author

Choose a reason for hiding this comment

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

Thanks Carlos!
I'll remove this part from the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants