Documentation

8.1 Code requirements when contributing

Code requirements

  • Code must meet the Symfony code standards and Symfony conventions, including PSR-2.
  • Use of translation tags for text
  • Use XML files instead of annotations: they are easier to override and have code completion
  • Integrated controllers need to be registered as service and need to have PSR-7 support
  • Use the short array notation: []
  • Fully unit tested, except controllers, commands and views

Bundle requirements

  • Bundles must be compatible with Composer and must contain a composer.json
  • The Bundle must contain a LICENSE file in the root of the bundle
  • The Bundle must contain a readme.md file in the root of the bundle, containing installation instructions
  • Other developer documentation can be placed in the Resources/doc folder in .md files and/or submitted to integratedfordevelopers.com
  • If the Bundle can be used by developers in other bundles, the following documentation is suggested:
    • Introduction
    • Description of functionality
    • How to start
    • Examples

Using third party code

The use of third party code is allowed if it meets the following requirements:

  • Dependencies can be managed with Composer (PHP) or Bower (Javascript).
  • The third party code is maintained well.
  • The third party code is Open Source and has a GPL-compatible license.