Revision: Thu, 25 Apr 2024 11:06:42 GMT
v1.0 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.12
Edit this page

Contributing

Feel free to contribute to the development of the framework or it's components. Please make sure that the following requirements are satisfied before submitting your pull request:

  • PSR-2 and PSR-4
  • KISS/SOLID
  • Your code must include tests

Make sure to create forum topic or issue prior to working on potential BC functionality or if you want to discuss design approach.

Help Needed In

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

  • Code quality feedback and proposals
  • TODOs
  • Usability improvements

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

Original guide author is not native English speaker, feel free to create PR for any text corrections.

Guide Improvements

If you feel like some "sugar" functionality (like shortcuts, constructor saturation or autowiring) can cause potential issues in future or reduce code testability please let me know so i can update guide and mention about potential architecture decisions or workarounds.

If you find the documentation lacking in certain areas - arhitectural wise or typos -, please create a issue on Github or better still a pull request containing the improvements.

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