README

Contribution

If you want to contribute, please follow these rules :

• Respect Gitflow: Respect following branches :
  • develop: Contains the last version of the bundle code.
  • master: Contains the production version of the bundle code.
  • feature/*: Branches adding new features to the bundle. They have to be merged on develop, and will be merge to master with the next release.
  • bugfix/*: Branches fixing non-blocking bugs. They have to be merged on develop, and will be merge to master with the next release.
  • hotfix/*: Branches fixing blocking bugs. They have to be merged on develop, master and every opened releases. After merging them to master, create a new patch version. (ex: v0.2.0 -> v0.2.1)
  • release/*: Branches containing future releases. They can be edited and will be merged, when finished, to develop and master. After merged to master, create a new minor version (ex: v0.2.1 -> v0.3.0) or major version (ex: v0.2.1 -> v1.0.0). To know if you need to increase the major version, ask yourself :
    • Does my release add a game-changing functionality.
    • Does my release breaks the retro-compatibility of the bundle.
    • Does that release will have to evolve in parallel to the current version.
• Launch and edit tests: If you run phpunit on this bundle, you'll have coverage generated in .phpunit-cache/code-coverage directory, take a look. /!\ TODO
• Edit the CHANGLOG.md file with your changes.
• Edit the TODO.md file with your ideas if any.