Skip to content

Update Setup instructions with prerequisites#516

Open
juanmaguitar wants to merge 1 commit intoWordPress:trunkfrom
juanma-wp:contributions/improve-setup-first-timers-experience
Open

Update Setup instructions with prerequisites#516
juanmaguitar wants to merge 1 commit intoWordPress:trunkfrom
juanma-wp:contributions/improve-setup-first-timers-experience

Conversation

@juanmaguitar
Copy link
Copy Markdown
Contributor

@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.

Comment thread package.json
"@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
Copy Markdown
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
Copy Markdown
Contributor 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