chore: Standardize NPM scripts across examples

Open
#330 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
tooling

Research direction

Review the dependency pull request at https://github.com/wpengine/hwptoolkit/pull/304 first, then inspect the npm scripts in each example and the corresponding README files. Compare the current commands with common npm conventions and standardize them across examples. Done means the example scripts are consistent and their READMEs document the updated commands.

Written by the indexing model from the issue text.

Description

As a Headless Toolkit contributor, I would like to see standardized npm scripts commands across the toolkit's examples in order to keep things simple.

Acceptance Criteria

  • NPM commands are standardized across the examples.
  • Readmes are updated to reflect adjustments

Notes

Dependent on https://github.com/wpengine/hwptoolkit/pull/304

Consider following industry standards. What are patterns in similar projects?

e.g.

npm start

Dominant language
PHP
Stars
47
Forks
3
Avg merge
1m
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wpengine/hwptoolkit

All issues in wpengine/hwptoolkit

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.