To be able to track bug reports directly, we recommends pull-request before posting in the issue tracker. If you have difficulties reproducing the bug for a pull request, issue reports are of course welcome.
The GitHub issue tracker is reserved for bugs reports or feature requests. If you have questions, feel free to post them on stackoverflow or our discord chanel.
Please keep in mind that the community will benefit if a solved problem can be found via google on stackoverflow.
If you are submitting a change that will affect a compiled file, such as most of
the files in
resources/js of any litstack repository, do
not commit the compiled files. Due to their large size, they cannot
realistically be reviewed by a maintainer. This could be exploited as a way to
inject malicious code into Litstack. In order to defensively prevent this, all
compiled files will be generated and committed by Litstack maintainers.
If you discover a security vulnerability within Litstack, please send an email to Lennart Carstens-Behrens at email@example.com or Jannes Behrens at firstname.lastname@example.org. All security vulnerabilities will be promptly addressed.
Litstack follows the PSR-2 coding standard as laravel. The Style CI included in the repository uses the laravel preset to keep the code in a familiar laravel standard.
Checkout an example of an example of a laravel PHPDoc on the laravel website.
Litstack uses a PHP CS Fixer config whose goal is to closely match the coding standard of laravel. The fixer can be executed with the following composer command.
Tests are divided into two parts.
PHP tests for the backend via
frontend via Jest. Depending on what you are working on
you may only want to test one part.
Installing the test dependencies can be done by installing the composer and/or npm packages:
composer install && npm install
Run the php tests via composer:
Some tests require a chromedriver to be running on port
9515. If you want to
cover them as well before pushing to your repository you may start a