Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (40 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 1.7 KB

Contributing

Feel free to contribute to the development of the Cycle ORM Schema Builder. Please make sure that the following requirements are satisfied before submitting your pull request:

  • KISS
  • PSR-12
  • 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

Testing Cycle ORM Schema Builder

To test Cycle ORM Schema Builder locally, download the cycle/schema-builder repository and start docker containers inside the tests folder:

$ cd tests/
$ docker compose up

To run full test suite:

$ ./vendor/bin/phpunit

To run quick test suite:

$ ./vendor/bin/phpunit tests/Schema/Driver/SQLite

Help Needed In

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.

Critical/Security Issues

If you found something which shouldn't be there or a bug which opens a security hole please let me know immediately by email team@spiralscout.com

Official Support

Cycle ORM Schema Builder are maintained by Spiral Scout.

For commercial support please contact team@spiralscout.com.

Licensing

Cycle ORM Schema Builder will remain under MIT license indefinitely.