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

Local development docs should mention wp-scripts, or install as part of setup #1267

Open
1 task done
benlk opened this issue Sep 8, 2024 · 2 comments
Open
1 task done
Labels
help wanted needs:documentation This requires documentation. type:bug Something isn't working.
Milestone

Comments

@benlk
Copy link

benlk commented Sep 8, 2024

Describe the bug

I'm installing this plugin to contribute a PR. When setting up the plugin, I noticed package.json and ran npm i. Checking package.json for commands, I ran npm run start. It appears that the local development workflow has an undocumented dependency on wp-scripts

Steps to Reproduce

  1. Clone this repo.
  2. npm install
  3. npm run start

Result:

$ npm run start

> [email protected] start
> wp-scripts start

sh: wp-scripts: command not found

Screenshots, screen recording, code snippet

No response

Environment information

  • OS: macOS 14.6
  • shell: bash, GNU bash version 3.2.57
  • node: 18.18.0
  • npm: 9.8.1

WordPress information

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@benlk benlk added type:bug Something isn't working. needs:documentation This requires documentation. labels Sep 8, 2024
@benlk
Copy link
Author

benlk commented Sep 8, 2024

I think there are three logical places to find this documentation:

  1. https://github.com/10up/distributor/blob/develop/CONTRIBUTING.md
  2. README.md
  3. in a new top-level DEVELOPING.md
  4. in the repo wiki

@jeffpaul jeffpaul moved this from Incoming to To Do in Open Source Practice Sep 9, 2024
@jeffpaul jeffpaul added this to the 2.1.0 milestone Sep 9, 2024
@dkotter
Copy link
Collaborator

dkotter commented Sep 9, 2024

We do already have developer documentation but it could be more explicit on the commands you need to run to get things ready.

I will say I can't reproduce the reported issue. You will need to use the proper node version, which is documented in the link above. Easiest way is to use nvm:

$ nvm use
$ npm install
$ npm run start

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted needs:documentation This requires documentation. type:bug Something isn't working.
Projects
Status: To Do
Development

No branches or pull requests

3 participants