Code¶

Initial Setup¶

Before working on patches for CakePHP, it’s a good idea to get your environment setup. You’ll need the following software:

• Git

• PHP 7.4 or greater

• PHPUnit 5.7.0 or greater

Set up your user information with your name/handle and working email address:

git config --global user.name 'Bob Barker'
git config --global user.email '[email protected]'

Get a clone of the CakePHP source code from GitHub:

• If you don’t have a GitHub account, create one.

• Fork the CakePHP repository by clicking the Fork button.

After your fork is made, clone your fork to your local machine:

git clone git@github.com:YOURNAME/cakephp.git

Add the original CakePHP repository as a remote repository. You’ll use this later to fetch changes from the CakePHP repository. This will let you stay up to date with CakePHP:

cd cakephp
git remote add upstream git://github.com/cakephp/cakephp.git

Now that you have CakePHP setup you should be able to define a $test database connection, and run all the tests.

Working on a Patch¶

Each time you want to work on a bug, feature or enhancement create a topic branch.

The branch you create should be based on the version that your fix/enhancement is for. For example if you are fixing a bug in 3.x you would want to use the master branch as the base for your branch. If your change is a bug fix for the 2.x release series, you should use the 2.x branch:

# fixing a bug on 3.x
git fetch upstream
git checkout -b ticket-1234 upstream/master

# fixing a bug on 2.x
git fetch upstream
git checkout -b ticket-1234 upstream/2.x

The above will create a local branch based on the upstream (CakePHP) 2.x branch. Work on your fix, and make as many commits as you need; but keep in mind the following:

• Follow the Coding Standards.

• Add a test case to show the bug is fixed, or that the new feature works.

• Keep your commits logical, and write clear commit messages that provide context on what you changed and why.

Submitting a Pull Request¶

Once your changes are done and you’re ready for them to be merged into CakePHP, you’ll want to update your branch:

# Rebase fix on top of master
git checkout master
git fetch upstream
git merge upstream/master
git checkout <branch_name>
git rebase master

This will fetch + merge in any changes that have happened in CakePHP since you started. It will then rebase - or replay your changes on top of the current code. You might encounter a conflict during the rebase. If the rebase quits early you can see which files are conflicted/un-merged with git status. Resolve each conflict, and then continue the rebase:

git add <filename> # do this for each conflicted file.
git rebase --continue

Check that all your tests continue to pass. Then push your branch to your fork:

git push origin <branch-name>

If you’ve rebased after pushing your branch, you’ll need to use force push:

git push --force origin <branch-name>

Once your branch is on GitHub, you can submit a pull request on GitHub.