Testing & Contributing

Submitting a PR

All steps mentioned are mandatory unless specified otherwise.

install the ee-development-test-suite project
ensure all tests pass with npm run check. this will run the following, each can be run individuall if they fail:
- npm run lint - checks for formatting errors
- npm run check-errors - checks for typescript errors
- npm run test - runs unit and integration tests
- npm run test-e2e - runs end to end tests (with puppeteer and the test bot)
- npm run build-client - runs the vite build process
specific tests can be run with npm run test -- --grep "Test Name" where "Test Name" is a partial string of a describe() or it() hook

push changes to a branch or fork, and make a DRAFT PR
if the PR addresses an issue completely, ensure the closes #1234 field has been filled out with the correct issue number (replacing 1234 with the issue number)
once a core contributor has signed off on the PR, reviewers will be assigned
once reviewers have been assigned, mark PR as READY
reviewer does manual QA locally & code review
multiple reviewers do manual QA
PR is merged and issue automatically closed