Contributions
Contribute headers, abstractions, frameworks.
Feel free to contribute. When contributing try to match this category:
Bug fixes
For bug fixes create and issue and pull request if possible.
Ideas
Use the discussion functionality and propose your idea:
- What you want to solve?
- Sample proof of concept code? (just how it could look)
Wait to take in account
- Always design your classes with dependency injection in mind (possibly constructor).
- Always think about tests -> how they should be written and if it is easy.
Checklist
- Run
composer run check. - Write PHPUnit tests.
- Update the documentation.
Lint and tests
Development requires PHP 8.3 or later. StrictPHP Conventions supplies Rector,
ECS, and PHPStan. Install dependencies with composer install.
Run composer qa to apply Rector and ECS, then run PHPStan and tests.
For checks without code transformations, use:
composer lint:upgrade:check
composer lint:check
composer analyse
composer test
The runtime SDK supports PHP 8.1 or later. Optional Larastrict adapter tests run
with composer test:larastrict when compatible Larastrict conventions are
available.
Contributors
Check our contributors on GitHub
Updating documentation
We are using Nuxtjs and every new addition should be documented. It's easy:
-
Go to docs folder
npm install -
Start the dev server and open localhost:3000
npm run dev -
Docs content is located at content/en/ and written in Markdown.
-
When creating new pages you need to set
position. To fix navigation and correct position per folder we are usingposition + X0where X is the position of the folder.