Ce dépôt contient la documentation française de PHPUnit.
La documentation est accessible à l'adresse https://phpunit.readthedocs.io/fr/latest/.
La documentation originale en anglais : https://github.com/sebastianbergmann/phpunit-documentation-english
Chaque traduction de la documentation est maintenue dans un dépôt dédié:
- Documentation en anglais
- Documentation en espagnol
- Documentation en français
- Documentation en brésilien et portuguais
- Documentation en japonais
- Documentation en chinois simplifié
- Documentation en russe
Si vous souhaitez créer une nouvelle traduction, merci d'ouvrir une issue sur le tracker de la documentation anglaise, indiquant la langue que vous souhaitez traduire. Un dépôt sera créé et ajouté aux traductions disponibles.
Idéalement, vous aurez déjà préparé une première version basée sur un fork ou une copie de la documentation anglaise qui sera ensuite importée dans le dépôt officiel.
- Python
- Sphinx
- Read the Docs Sphinx Theme
Pour générer la documentation, exécuter la ligne de commande suivante:
$ make html
Ensuite, vous trouverez les fichiers HTML dans build/html.
$ pip install docutils-ast-writer
$ npm install
$ ./node_modules/.bin/textlint src
Merci de prendre du temps pour aider.
- Mettre à jour la documentation suite aux améliorations de la documentation anglaise
- S'il s'agit d'une mise à jour, préciser le commit de la documentation originale avec lequel la synchronisation est faite
- Corriger les typos, les fautes d'orthographes, de grammaire et de syntaxes
- Détecter le franglais et les anglicismes
- Revue de pair sur les PR
- Vérifier le guide de traduction
- Faire une Pull requests documentée vers master (idéalement depuis une "feature branch").
- Vérifier que la compilation passe avant de faire une pull request
- Laisser les exemples de code en anglais
- Respecter les sauts de ligne de la documentation originale afin de faciliter les recherches et les comparaisons (les numéros de lignes entre la documentation anglaise et française doivent être les mêmes)
Dans le tableau suivant sont recensées les règles de traductions utilisées de manière à garantir la cohérence d'ensemble. Sont notamment visés les termes techniques.
| Anglais | Français |
|---|---|
| actual | constatée (valeur) |
| array | traduit par tableau sauf quand on fait explicitement référence à PHP |
| assertion | traduit par asssertion, plus parlant que affirmation |
| composable | composable (rien trouvé de mieux) |
| expected | attendue (valeur) |
| framework | framework |
| isolated | indépendant (isolé est ambigu, étanche un peu moins...) |
| notice | remarque |
| return | retourne plutôt que renvoie |
| requirements | pré-requis |
| extension | extensions |
| code coverage | couverture de code |
| appendix | annexe |
| fixture | fixture (pas trouvé mieux en français) |
| stub | bouchon |
| verbe ing | traduits par l'infinitif dans les titres : testing => tester |
Lectures recommandées :