Revision: Wed, 06 Dec 2023 18:31:41 GMT
v3.1 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.10
Edit this page

Contributing

Feel free to contribute to the development of the Framework or its components. 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 search for advice or suggestions https://discord.gg/TFeEmCs

Help Needed

If you'd like to help but don't know where to start:

  • TODOs, typos, comments
  • Updating to latest dev-dependencies (PHPUnit, Mockery, etc.)
  • RFCs
  • Check Open Issues
  • More tests are always welcome
  • More static analyzers and linters are also welcome
  • Documentation translation

Feel free to suggest any ideas related to architecture, docs (docs are never complete), adaptation, or community.

The 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 wolfy-j@spiralscout.com

Official Support

Spiral Framework and all related components are maintained by Spiral Scout.

For commercial support, please contact team@spiralscout.com.

Licensing

Spiral Frameworks and its components will remain under MIT license indefinitely.