Skip to content

Commit

Permalink
chore: update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Soare-Robert-Daniel committed Dec 7, 2023
1 parent 9cb8574 commit bbc83a9
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,19 @@ This projects requires you to have Node.js (with npm) and Composer.
- You can run `npm ci` & `composer install` to install dependencies.
- Once done, you can run `npm run build` to generate build files.
- You can also use `npm run dev` to generate dev build if you are working on the files.

> [!NOTE]
> The minimum Node version is 16. The version recommended is 18 or higher (tested up to 21). For PHP, use 7.4.
## E2E Testing

We use Playwright to write the E2E together with WordPress tool set.

Use `npm run wp-env start` to start the testing environment.

> [!NOTE]
> The testing instance has a port that need to be free to work with setup (usually the port 8889).
Install Playwright with `npm install -g playwright-cli` and `npx playwright install`.

Use `npm run test:e2e:playwright:ui` to lunch it in UI mode for easy development.

0 comments on commit bbc83a9

Please sign in to comment.