Contribuer¶

Avant de contribuer, vous devez maîtriser le language markup rest utilisé dans la documentation.

La documentation Symfony2 est hébergée sur GitHub:

1

https://github.com/symfony/symfony-docs

Si vous voulez soumettre un correctif, forkez le dépôt officiel sur GitHub et clonez votre dépot :

1

$ git clone git://github.com/YOURUSERNAME/symfony-docs.git

Conformément au code source de Symfony, le dépôt de la documentation est séparé en trois branches : 2.0 pour la dernière version de Symfony 2.0.x, 2.1 pour la dernière version de SYmfony 2.1.x et master qui est la branche de développement des versions à venir.

A moins que vous ne documentiez une fonctionnalité nouvelle, vos changements doivent toujours être basés sur la branche 2.0 plutôt que sur la branche master. Pour effectuer ceci faites un checkout la branche 2.0 :

1

$ git checkout 2.0

Ensuite, créez une branche dédiée pour vos changements :

1

$ git checkout -b improving_foo_and_bar

Vous pouvez maintenant appliquer vos changements directement à cette branche et les commiter. Ensuite, envoyez cette branche à votre dépôt et initiez une requête (pull request). Celle-ci devra être entre votre branche improving_foo_and_bar et la branche symfony-docs master.

Si vous avez basé vos changement sur la branche 2.0 vous devez changer la branche de base pour qu'elle soit 2.0 sur la page de prévisualisation :

GitHub explique en détail les requêtes de mise à jour ou pull requests .

Standards¶

Dans le but d'aider le lecteur autant que possible, et de créer des exemples de code qui semblent familiers, vous devriez suivre ces règles :

• Le code suit les Standards de code Symfony ainsi que les Standards de code Twig;
• Chaque ligne devrait se terminer après le premier mot qui dépasse le 72ème caractère (ainsi, la plupart des lignes font environ 72 à 78 caractères);
• Lorsque vous n'affichez pas une ou plusieurs lignes de code, vous placez ... en commentaire à l'endroit où les lignes sont censées se trouver. Ces commentaires sont : // ... (php), # ... (yaml/bash), {# ... #} (twig), <!-- ... --> (xml/html), ; ... (ini), ... (text);
• Lorsque vous cachez une partie d'une ligne, par exemple une variable, placez ...

(sans commentaire) à l'endroit où elle est censée être;

• Description du code caché : (facultatif) Si vous cachez plusieurs lignes : la description peut être placée après les ... Si vous ne cachez qu'une partie de la ligne : la description peut être placée avant la ligne;
• Si c'est utile, un bloc de code devrait commencer par un commentaire indiquant le nom du fichier qui contient le code. Ne mettez pas de ligne vide après ce commentaire, à moins que la prochaine ligne ne soit également un commentaire;
• Vous devriez mettre un $ devant chaque ligne de commande;
• Le raccourci :: est préféré à .. code-block:: php pour commencer un block de PHP.

Un exemple:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

// src/Foo/Bar.php

// ...
class Bar
{
    // ...

    public function foo($bar)
    {
        // définit foo avec la valeur de bar
        $foo = ...;

        // ... vérifie si $bar a la bonne valeur

        return $foo->baz($bar, ...);
    }
}

Signaler une erreur¶

La contribution la plus facile que vous pouvez effectuer est de signaler une erreur : une faute de frappe, une grammaire imparfaite, un exemple de code erroné, une explication manquante ...

Étapes:

• Soumettez un bogue dans le gestionnaire de bogues;
• (optionnel) Proposez un correctif.

Traductions¶

Lisez la documentation dédiée traductions.