Feel free to contribute to the development of the Cycle ORM or its components. Please make sure that the following requirements are satisfied before submitting your pull request:
- KISS
- PSR-2 (your PRs will be automatically tested)
declare(strict_types=1);
is mandatory- Your code must include tests
Use our discord server to check for the advice or suggestion https://discord.gg/FZ9BCWg
To test ORM engine locally, download the cycle/orm
repository and start docker containers inside the tests folder:
$ cd tests/
$ docker-composer up
To run full test suite:
$ ./vendor/bin/phpunit
To run quick test suite:
$ ./vendor/bin/phpunit tests/ORM/Driver/SQLite
If you want to help but don't know where to start:
- TODOs
- Updating to latest dev-dependencies (PHPUnit, Mockery, etc)
- Quality recommendations and improvements
- Check Open Issues
- More tests are always welcome
- Typos
Feel free to propose any ideas related to architecture, docs (docs are never complete), adaptation or community.
Original guide author is not a native English speaker, feel free to create PR for any text corrections.
If you found something which shouldn't be there or a bug which opens a security hole please let me know immediately by email [email protected]
Cycle ORM and all related components are maintained by Spiral Scout.
For commercial support please contact [email protected].
Cycle ORM and its components will remain under MIT license indefinitely.