Skip to content
This is the documentation for pieceofcake2/cakephp, a community-maintained fork of CakePHP 2.x for PHP 8. About this fork.

Code ​

Pull requests are a great way to contribute code back to the Piece of Cake 2 fork. Create them on GitHub against the relevant pieceofcake2/* repository, usually pieceofcake2/cakephp for the framework.

Before you start, keep the goals of the fork in mind: it maintains PHP 8 compatibility, fixes bugs and security issues, and supports a gradual migration path to CakePHP 5. It does not add new features. If you are not sure whether a change fits, open an issue first and ask.

The steps are described in the contribution guide:

  • Initial Setup: the required software, forking and cloning the repository, and composer install.
  • Running the Tests: PHPUnit 9.6, and how to select the database for the framework's test suite with the DB environment variable.
  • Working on a Change: topic branches, the checks to run before you open a pull request (phpcs, phpunit, composer validate, PHPStan), and CHANGELOG.md and UPGRADE.md entries.
  • Coding Standard and Backwards Compatibility.

The rules of the coding standard are described in Coding Standards.

NOTE

Remember that all code you contribute to the fork will be licensed under the MIT License, the license of CakePHP.

Based on the CakePHP Cookbook. Content licensed under CC BY-NC-SA 4.0. Not affiliated with the Cake Software Foundation.