Code¶

Configuration initiale¶

Avant de travailler sur les correctifs pour CakePHP, c’est une bonne idée de récupérer la configuration de votre environnement. Vous aurez besoin du logiciel suivant:

• Git

• PHP 5.3.0 ou supérieur

• ext/mcrypt

• ext/mbstring

• PHPUnit 3.7.0 ou supérieur (3.7.38 recommandé)

• MySQL, SQLite, ou Postgres

Mettez en place vos informations d’utilisateur avec votre nom / titre et adresse e-mail de travail:

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

Récupérer un clone du code source de CakePHP sous GitHub.:

• Si vous n’avez pas de compte github , créez en un.

• Forkez le dépôt de CakePHP en cliquant sur le bouton Fork.

Après que le fork est fait, clonez votre fork sur votre machine local:

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

Ajoutez le dépôt CakePHP d’origine comme un dépôt distant. Vous utiliserez ceci plus tard pour aller chercher les changements du dépôt CakePHP. Cela vous permettra de rester à jour avec CakePHP:

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

Maintenant que vous avez configuré CakePHP, vous devriez être en mesure de définir un $ test : ref: connexion à la base <database-configuration>, et : ref: exécuter tous les tests de <running-tests>.

Travailler sur un correctif¶

A chaque fois que vous voulez travailler sur un bug, une fonctionnalité ou une amélioration, créez une branche avec un sujet.

La branche que vous créez devrait être basée sur la version pour laquelle se tourne votre correctif/amélioration. Par exemple, si vous régler un bug dans 2.3, vous pouvez utiliser la branche 2.3 comme la base de votre branche. Cela simplifiera la fusion future de vos changements:

# gérer un bug dans 2.3
git fetch upstream
git checkout -b ticket-1234 upstream/2.3

Ce qui précède va créer une branche locale basée sur la branche (CakePHP) 2.3 en amont. Travaillez sur votre correctif, et faîtes autant de commits que vous le souhaitez; mais gardez à l’esprit ce qui suit:

• Suivez ceci Normes de codes.

• Ajoutez un cas de test pour montrer que le bug est réglé, ou que la nouvelle fonctionnalité marche.

• Faîtes des commits logiques, et écrivez des messages de commit bien clairs et concis.

Soumettre un pull request¶

Une fois que vos changements sont faits et que vous êtes prêts pour la fusion dans CakePHP, vous voudrez mettre à jour votre branche:

git checkout 2.3
git fetch upstream
git merge upstream/2.3
git checkout <branch_name>
git rebase 2.3

Cela récupérera et fusionnera tous les changements qui se sont passés dans CakePHP depuis que vous avez commencé. Cela rebasera - ou remettra vos changements au dessus du code actuel. Il y aura peut-être un conflit pendant le rebase. Si le rebase quitte rapidement, vous pourrez voir les fichiers qui sont en conflit/Non fusionnés avec git status. Résolvez chaque conflit et continuer le rebase:

git add <filename> # Faîtes ceci pour chaque fichier en conflit.
git rebase --continue

Vérifiez que tous les tests continuent. Ensuite faîtes un push de votre branche à votre fork:

git push origin <branch-name>

Une fois que votre branche est sur GitHub, vous pouvez discuter de cela sur la mailing-liste cakephp-core ou soumettre un pull request sur GitHub.