PRs are welcome, all branches should follow the process laid out on this page.
- Install the project if you haven't done so already
- Create a new branch
- Code! :)
- See the project CLI docs for info on commonly used commnds
- Test the changes
- See the testing docs for info on one-time set-up & advanced use cases
- Commit, push & open a pull request detailing your changes, inline with the guidance below
The following guidelines should be observed for all pull requests.
- Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
- You may need to rebase to avoid merge conflicts, or tidy up the history.
Each of the following commands must complete without errors for a PR to be considered for merging. If any command fails, all commands should be re-run in turn following any action necessary to resolve the reported issues.
Run the project's linters with:
$ npm run lint
# > lint...Run the project's static analysis tests with:
$ composer test:types
# > ./vendor/bin/phpstan analyse...Run the tests configured in the project's PHPUnit config with:
$ php artisan test
# PASS Tests\Unit\App\...Run the browser tests configured in the project's PHPUnit Dusk config with:
$ php artisan dusk
# DevTools listening on...See the testing docs for first time set-up instructions & more info on running the project's tests.
| Prev | Next |
|---|---|
| <<< Project CLI Commands <<< ........................... | ................................... >>> Running Tests >>> |