WordPress / WordPress/phpunit-test-runner

Document why NodeJS is needed.

Open
#243 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ContributorDay enhancement WCUS26
Dominant language
PHP
Stars
77
Forks
77
Avg merge
15d 15h
Merged PRs (30d)
4

Description

Right now the test suite requires NodeJS to prepare the tests and builds from a grunt file.
We should document what is actually done there as the grunt file includes more steps that might not be needed to actually run the hosting test suite.

Describe the solution you'd like
A part in the readme or the hosting handbook which describes and explains the need for NodeJS. This will make sure that hosts trying to run the hosting tests can understand the requirements.

Describe alternatives you've considered
Find a way to remove the NodeJS requirements and run the required build steps for the phpunit tests from php.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reading Gruntfile.js and the existing README or hosting handbook. Identify which NodeJS-driven steps are required to prepare and build the PHPUnit tests, then document those requirements and their purpose so hosts can understand why NodeJS is needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, php
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.