Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
94 lines (68 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
94 lines (68 loc) · 2.51 KB

Contributing

Development Environment

Prefer the Nix development shell from the repository root:

nix develop

The shell provides PHP 8.5, Xdebug coverage support, Composer, Node.js 22, npm, zip/unzip, and the Linux runtime libraries needed by Cypress. It also keeps Composer, npm, and Cypress caches under .cache/.

If flakes are not enabled globally, run commands with:

nix --extra-experimental-features "nix-command flakes" develop

The .envrc file uses use flake; run direnv allow once if you use direnv.

Setup

git clone https://github.com/formapro/JsFormValidatorBundle.git
cd JsFormValidatorBundle
nix develop
composer update
npm install

If Cypress reports that its binary is missing, install it into the local cache:

npx cypress install

Without Nix, install PHP 8.4 or newer, Composer, Node.js 22, npm, and the Cypress system dependencies locally before running the same commands.

Install Vendors Via Docker

The Docker development image is kept as an alternative way to install project vendors without using host PHP or Composer:

docker compose build php-fpm
docker compose run --rm --no-deps -u "$(id -u):$(id -g)" php-fpm composer update
docker compose run --rm --no-deps -u "$(id -u):$(id -g)" php-fpm npm install

The image uses PHP 8.5, Composer 2, Node.js 22, and the PHP extensions needed by the Symfony 8 test fixture. It also stores Composer, npm, and Cypress caches under .cache/.

Checks

Run the same checks that GitHub Actions runs on pushes and pull requests:

composer validate --strict
composer test
composer phpstan
composer coverage
npm test
npm run test:coverage
git diff --check

For one-off commands without entering the shell:

nix develop -c composer test
nix develop -c npm test

Test Layout

  • PHP unit and controller tests live under Tests/Unit and Tests/Controller.
  • JavaScript unit tests live beside the source files under src/Resources/public/js and use the .test.js suffix.
  • Browser smoke tests live under cypress/ and run against Tests/app.
  • Tests/app is a Symfony fixture application used by the e2e tests.

Do not commit generated dependencies or build output such as vendor/, node_modules/, Tests/app/node_modules/, build/, coverage reports, Cypress videos, or local cache directories.

Docker Notes

The Docker stack is maintained for dependency installation and ad hoc local commands. Nix remains the preferred environment for exact local parity with the documented checks.