- Notifications
You must be signed in to change notification settings - Fork266
Améliorations diverses du README.#1288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
1732779
Modifs mineures.
e23f3e9
Corrections mineures.
b9c9fab
Modifications diverses.
698f6c2
Encore des modifs.
0410224
Correction liste.
5bac4b3
Suggestions de ChristopheNan.
awecx1ef877c
Suggestion de christopheNan sur podiff.
97309e4
Merge branch 'contributing_misc4' of https://github.com/awecx/python-…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
120 changes: 68 additions & 52 deletionsCONTRIBUTING.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -6,7 +6,7 @@ Prérequis | ||
- un compte `Github <https://github.com/join>`_ ; | ||
- un client ``git`` `Linux <https://git-scm.com/>`_ ou `Windows <https://gitforwindows.org/>`_ ; | ||
- un éditeur de fichier ``.po`` (comme `Poedit <https://poedit.net/>`_). | ||
Instructions | ||
------------ | ||
@@ -20,17 +20,17 @@ où vous avez le droit de faire des modifications. | ||
.. code-block:: bash | ||
# Clonez votre fork Github avec `git` en utilisant ssh | ||
git clone git@github.com:VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git | ||
#ou bien viaHTTPS | ||
git clone https://github.com/VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git | ||
# Allez dans le répertoire cloné | ||
cd python-docs-fr/ | ||
# Ajoutez le dépôt officiel (nommé upstream), | ||
#ceci permet à *git* de savoir quoi etoù est *upstream* | ||
git remote add upstream https://github.com/python/python-docs-fr.git | ||
Ensuite, vous devez trouver un fichier sur lequel travailler | ||
@@ -41,17 +41,16 @@ déjà été traduit et ce qui ne l'a pas été). | ||
Une fois que vous avez choisi un fichier sur lequel travailler, veuillez | ||
ouvrir un `ticket sur Github <https://github.com/python/python-docs-fr/issues>`_ | ||
en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po`` | ||
(par exemple « Je travaille sur library/sys.po »). | ||
Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés | ||
dans les tickets et les *pull requests*. | ||
Équipez-vousaussi de quelques outils pour vous aider dans | ||
votre traduction (voir `Outils utiles pour la traduction`_). | ||
Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier, | ||
suivez cette procédure : | ||
Pour travailler, nous aurons besoin d'une branche, basée sur une version à jour | ||
(fraîchement récupérée) de la branche upstream/3.8. On met donc à jour notre | ||
version locale. | ||
@@ -71,22 +70,22 @@ Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3 | ||
git checkout -b library-sys upstream/3.8 | ||
Vous pouvez maintenant travailler sur le fichier. | ||
Si vous utilisez Poedit, n'oubliez pas de configurer votre nom et votreadresse de courriel | ||
(Édition→ Préférences→ Général). | ||
Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères | ||
(Édition→ Préférences→ Avancé→ Passer à la ligne à 79). | ||
Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment. | ||
.. code-block:: bash | ||
poedit library/sys.po | ||
Ou lancez simplementPoedit puis « Fichier » → « Ouvrir ». | ||
Si vous n'utilisez pasPoedit, vous pouvez utiliser `powrap <https://github.com/JulienPalard/powrap>`_ | ||
(voir la section *outils*)qui reformate correctement le fichier que avez vous avez modifié. | ||
Exécutez `powrap -m` (reformater tous les fichiers modifiés) | ||
ou `powrap library/sys.po` (un fichier en particulier) : | ||
@@ -95,8 +94,8 @@ ou `powrap library/sys.po` (un fichier en particulier) : | ||
powrap -m | ||
Pour l'orthographe, une liste blanche de certains termes techniques ou | ||
de noms propres, comme « Guido », « C99 » ou « sérialisable », est | ||
stockée dans le fichier « dict » à la racine du projet. Vous pouvez | ||
bien sûr y ajouter une entrée si nécessaire. | ||
La commande suivante lance les vérifications nécessaires. | ||
@@ -105,8 +104,8 @@ La commande suivante lance les vérifications nécessaires. | ||
make verifs | ||
C'est le moment de`git add` et`git commit`. | ||
`git add` place nos modifications dans l'index de Git en | ||
attendant d'être propagées dans le dépôt local. | ||
.. code-block:: bash | ||
@@ -135,10 +134,11 @@ Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/p | ||
et un joli bouton « Compare & pull request » devrait apparaître au bout de | ||
quelques secondes vous indiquant que vous pouvez demander une pull request. | ||
Mettez dans le commentaire de la pull request le texte suivant : | ||
« Closes #XXXX » où XXXX est le numéro du ticket GitHub créé pour réserver le fichier traduit. | ||
À partir de là, quelqu'un passera en revue vos modifications, et vous fera des | ||
suggestions etcorrections. Pour les prendre en compte, retournez sur votre branche | ||
contenant du fichier concerné (au cas où vous auriez commencé quelque chose d'autre | ||
sur une autre branche) : | ||
@@ -183,18 +183,18 @@ Vous pouvez utiliser `potodo`_, un outil fait pour trouver des fichiers ``po`` | ||
local. | ||
Vous pouvez choisir n'importe quel fichier non réservé dans la liste | ||
renvoyée par la commande **à l'exception** des fichiers de : | ||
- ``c-api/`` car c'est une partie très technique ; | ||
- ``whatsnew/`` car les anciennes versionsdePython sont pour la plupart obsolètes et leurs journaux de modificationsne sont pas les pages les plus consultées ; | ||
- ``distutils/`` et ``install/`` car ces pages seront bientôt obsolètes. | ||
Vous pouvez commencer par des tâches faciles comme réviser les entrées | ||
*fuzzy* pour aider à garder la documentation à jour (trouvez les entrées | ||
*fuzzy* l'aide de `make fuzzy`). | ||
Vous pouvez également relire des entrées déjà traduites pour vous faire une | ||
idée, et passer ensuite à la traduction de celles qui nelesont pasencore. | ||
Vous pouvez les trouver à l'aide de `make todo`… | ||
Vous pouvez aussi « traduire » des liens hypertextes | ||
@@ -210,7 +210,7 @@ Si vous devez absolument utiliser un mot anglais, mettez-le en *italique* | ||
(entouré par des astérisques). | ||
Pour les caractères spéciaux, référez-vous à la section | ||
`Caractères spéciaux`_. | ||
Conseils | ||
-------- | ||
@@ -249,13 +249,22 @@ Dans un souci de lisibilité et en accord avec la préconisation de | ||
l'Académie française, nous utilisons le masculin pour indiquer un | ||
genre neutre. Par exemple : l'utilisateur ou le lecteur. | ||
Style | ||
~~~~~ | ||
Une bonne traduction est une traduction qui transcrit fidèlement l'idée originelle | ||
en français, sans rien ajouter ni enlever au fond, tout en restant claire, concise et | ||
agréable à lire. Les traductions mot-à-mot sont à proscrire et il est permis — même | ||
conseillé — d'intervertir des propositions ou de réarranger des phrases de la | ||
documentation anglaise, si le rythme l'exige. Il faut aussi chercher des | ||
équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre | ||
garde aux anglicismes. | ||
Glossaire | ||
~~~~~~~~~ | ||
Afin d'assurer la cohérence de la traduction, voici quelques propositions et | ||
rappels pour les termes fréquents à traduire. | ||
Pour trouver facilement comment un terme est déjà traduit dans la | ||
documentation, vous pouvez utiliser `pogrep`_. | ||
@@ -268,6 +277,7 @@ abstract data type type abstrait | ||
argument argument (à ne pas confondre avec *paramètre*) | ||
backslash antislash, *backslash* | ||
backtrace trace d'appels, trace de pile | ||
backport rétroporter | ||
bound lier | ||
bug bogue, *bug* | ||
built-in natif | ||
@@ -323,6 +333,7 @@ subprocess sous-processus | ||
support prendre en charge, implémenter (« supporter » n'a | ||
pas le même sens en français) | ||
specify définir, préciser (plutôt que « spécifier ») | ||
typically normalement, habituellement, comme d'habitude (plutôt que « typiquement ») | ||
thread fil d'exécution | ||
traceback trace d'appels, trace de pile | ||
tuple n-uplet | ||
@@ -349,14 +360,14 @@ compositions suivantes : | ||
- :kbd:`Compose SPACE SPACE` donne une espace insécable | ||
- :kbd:`Compose . . .` donne ``…`` | ||
Comme vous l'avez noté, presque toutes les compositions sontintuitives, | ||
vous pouvez doncenessayerd'autres et elles devraient tout | ||
simplement fonctionner : | ||
- :kbd:`Compose C =` donne ``€`` | ||
- :kbd:`Compose 1 2` donne ``½`` | ||
- :kbd:`Compose ' E` donne ``É`` | ||
-etc. | ||
Comment définir la touche de composition ? | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
@@ -389,7 +400,7 @@ Ensuite, dans votre fichier '~/.xsession', ajoutez : | ||
xmodmap $HOME/.Xmodmap | ||
Sous X, avec un bureau graphique, tel que Gnome, ou Xfce, il faut aller | ||
modifier dans les« Paramètres » → « Clavier » → «Disposition » → | ||
« Touche composée ». Pour finir, redémarrez votre session. | ||
=> Sous Windows, vous | ||
@@ -398,10 +409,10 @@ pouvez utiliser `wincompose <https://github.com/SamHocevar/wincompose>`_. | ||
Le cas de « --- », « -- », « ... » | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
La version anglaise utiliseles | ||
`smartquotes <http://docutils.sourceforge.net/docs/user/smartquotes.html>`_, | ||
quifonctionnent en anglais, maiscausent des problèmes dans d'autres langues. | ||
Nouslesavons doncdésactivées (voir #303) dans la version française. | ||
Les *smartquotes* sont normalement responsables de la transformation de | ||
``--`` en *en-dash* (``—``), de ``---`` en *em-dash* (``—``), et de | ||
@@ -419,7 +430,7 @@ guillemets anglais ``"``. Cependant, Python utilise les guillemets | ||
anglais comme délimiteurs de chaîne de caractères. Il convient donc de | ||
traduire les guillemets mais pas les délimiteurs de chaîne. | ||
=> Si vous voyez : | ||
| « "…" » : faites :kbd:`Compose < <` ou :kbd:`Compose > >` | ||
Le cas de « :: » | ||
@@ -436,7 +447,7 @@ En français, nous mettons une espace insécable devant nos deux-points, comme : | ||
=> Traduisez ``mot deux-points deux-points`` par | ||
``mot espace-insécable deux-points deux-points``. | ||
Pour saisir une espace insécable faites :kbd:`Compose SPACE SPACE` | ||
Le cas des doubles-espaces | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
@@ -470,7 +481,7 @@ Par exemple : | ||
- le dernier paragraphe. | ||
MalheureusementPoedit n'aime pas les différences de ponctuation finales | ||
entre un paragraphe et sa traduction ; il faut passer outre ses avertissements. | ||
Vous pouvez aussi rajouter un commentaire dans le fichier *.po* pour avertir | ||
les traducteurs suivants et éviter qu'ils ne « corrigent » par erreur ces | ||
@@ -493,12 +504,11 @@ Pogrep | ||
| Permet de rechercher dans la documentation des termes. Utile si on a un doute | ||
sur comment traduire un terme ou chercher la traduction d'un terme dans | ||
d'autres fichiers. | ||
| Installez-le à l'aide de *pip* (``pip install pogrep``). | ||
| `Lien vers le dépôt <https://github.com/JulienPalard/pogrep>`__ | ||
Padpo (beta) | ||
~~~~~~~~~~~~ | ||
| Analyseur de code qui vérifie la grammaire et l'orthographe et la syntaxe | ||
du fichier .po. | ||
@@ -510,12 +520,11 @@ Powrap | ||
~~~~~~ | ||
| Formateur de fichier .po. | ||
| Installez-le à l'aide de *pip* (``pip install powrap``). | ||
| `Lien vers le dépôt <https://github.com/JulienPalard/powrap>`__ | ||
Ressources de traduction | ||
------------------------ | ||
- les canaux IRC sur freenode : | ||
@@ -530,17 +539,21 @@ Ressources de traduction | ||
- le `glossaire de la documentation Python <https://docs.python.org/fr/3/glossary.html>`_, car il est déjà traduit, | ||
- les `glossaires et dictionnaires de traduc.org <https://traduc.org/Glossaires_et_dictionnaires>`_, en particulier le `grand dictionnaire terminologique <http://gdt.oqlf.gouv.qc.ca/>`_ de l'Office québécois de la langue française, | ||
- Wikipédia. En consultant un article sur la version anglaise, puis en basculant sur la version francaise pour voir comment le sujet de l'article est traduit ; | ||
- le `guide stylistique pour le français de localisation des produits Sun | ||
<https://web.archive.org/web/20160821182818/http://frenchmozilla.org/FTP/TEMP/guide_stylistique_December05.pdf>`_ donne | ||
beaucoup de conseils pour éviter une traduction trop mot à mot ; | ||
- `Petites leçons de typographie <https://jacques-andre.fr/faqtypo/lessons.pdf>`_, | ||
résumé succint de typographie, utile pour apprendre le bon usage des | ||
majuscules, des espaces, etc. | ||
L'utilisation de traducteurs automatiques comme `DeepL https://www.deepl.com/` ou semi-automatiques comme | ||
`reverso https://context.reverso.net/traduction/anglais-francais/` est proscrite. | ||
Les traductions générées sont très souvent à retravailler, ils ignorent les règles énoncées sur cette | ||
page et génèrent une documentation au style très « lourd ». | ||
Simplification des diffs git | ||
---------------------------- | ||
awecx marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
Les diffs git sont souvent encombrés de changements inutiles de numéros | ||
de ligne, comme : | ||
@@ -566,6 +579,9 @@ ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre | ||
git config diff.podiff.textconv podiff | ||
Pas d'inquiétude, cela ne change la façon dont Git voit les changements que sur | ||
les fichiers de la traduction, sans incidence sur les autres. | ||
Maintenance | ||
----------- | ||
14 changes: 7 additions & 7 deletionsREADME.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.