This repository follows specific coding conventions and build steps. Please review the guidelines below before submitting changes.
- PHP: 4 spaces per indent and adhere to the WordPress Coding Standards.
- TypeScript: 2 spaces per indent. Source files live in
src/and should avoid jQuery.
Install dependencies once:
composer install
npm installRun linting and the test suite prior to committing:
composer lint
composer testIf your commit only touches documentation or other non-code files, you may avoid
running the full GitHub Actions workflow by appending [skip ci] or
skip-checks: true to the commit message. See
docs/CI_GUIDELINES.md for details.
If you modify any TypeScript files, rebuild the assets:
npm run buildDuring development you can watch and rebuild automatically with:
npm run devFor design context and architectural decisions, see docs/ARCHITECTURE.md. For instructions on suppressing unnecessary CI runs, see docs/CI_GUIDELINES.md.