Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e09ad79

Browse files
committed
Ajout explications.
1 parent c7a0b97 commit e09ad79

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

CONTRIBUTION.rst

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Guide de contribution à la documention via GitHub.
22
===================================================
33

4-
Prérequis :
5-
------------
4+
Prérequis
5+
---------
66

77
- Un compte `Github <https://github.com/join>`_.
88
- ``git`` `installé <https://help.github.com/articles/set-up-git/>`_ (pour Windows, voir
@@ -35,19 +35,22 @@ où vous avez le droit de faire des modifications.
3535
git remote add upstream https://github.com/python/python-docs-fr.git
3636
3737
Ensuite, vous devez trouver un fichier sur lequel travailler
38-
(pour vous aiguillez vous pouvez vous rendre à `Que traduire ?`_).
38+
(pour vous aiguillez vous pouvez vous rendre à `Que traduire ?`_ et lire
39+
les explications concernant `potodo`_ qui vous permettra de voir ce qui a
40+
déjà été traduit et ce qui ne l'a pas été).
3941

4042
Une fois que vous avez choisi un fichier sur lequel travailler, veuillez
41-
ouvrir un `ticket sur Github <https://github.com/python/python-docs-fr/issues>`_ dans
42-
le format ``Je travaille sur DOSSIER/FICHIER.po``.
43+
ouvrir un `ticket sur Github <https://github.com/python/python-docs-fr/issues>`_
44+
en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po``
45+
(par exemple «Je travaille sur library/csv.po»).
4346
Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés
4447
dans les tickets et les *pull requests*.
4548

4649
N'hésitez pas non plus à vous équiper de quelques outils pour vous aider dans
4750
votre traduction (voir `Outils utiles pour la traduction`_)
4851

49-
Vous êtes maintenant prêt à commencer une session de travail. Chaque
50-
fois que vous commencerez un nouveau fichier, commencez ainsi :
52+
Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier,
53+
suivez cette procédure :
5154

5255
.. code-block:: bash
5356
@@ -58,14 +61,16 @@ fois que vous commencerez un nouveau fichier, commencez ainsi :
5861
5962
# On créé ensuite une branche. Il est pratique de nommer la branche en fonction du
6063
# fichier sur lequel on travaille. Par exemple, si vous travaillez sur
61-
# « library/venv.po », vous pouvez nommer votre branche « library-venv ».
64+
# « library/sys.po », vous pouvez nommer votre branche « library-sys ».
6265
# Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ».
6366
git checkout -b library-sys upstream/3.8
6467
6568
# Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit).
6669
# N'oubliez pas de configurer poedit pour passer à la ligne à 79 caractères.
6770
# (Édition -> Préférences -> Avancé -> Passer à la ligne à : 79)
68-
# Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment.
71+
# Vous pouvez également saisir votre nom/email si vous le souhaitez dans ces mêmes
72+
# Préférences -> Général.
73+
# Remplacez « library/sys.po » par le fichier que vous avez choisi précédemment.
6974
poedit library/sys.po
7075
7176
# Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap` (voir la section *outils*)
@@ -78,18 +83,21 @@ fois que vous commencerez un nouveau fichier, commencez ainsi :
7883
# de noms propres, comme « Guido », « C99 » ou « sérialisable », est
7984
# stockée dans le fichier « dict » à la racine du projet. Vous pouvez
8085
# bien sûr y ajouter une entrée si nécessaire.
86+
# La commande suivante va lancer les vérifications nécessaires.
8187
make verifs
8288
8389
# C'est le moment de git add et git commit
84-
# C'est l'occasion de se relire avec l'option -p ou -u.
90+
# git add va permettre de déplacer nos modifications dans l'index de Git en
91+
# attendant d'être déplacée dans le dépôt local.
8592
git add library/sys.po
8693
94+
# Puis on bascule les modifications dans le dépôt local avec un commit.
8795
git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :)
8896
8997
# Poussez ensuite vos modifications sur votre fork Github.
9098
# Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette
91-
# branche est liée à votre fork Github (et donc qu'un futur `git pull` sache quoi
92-
# tirer)
99+
# branche est liée à votre fork Github (et donc que vos futurs `git pull` et
100+
# `git push` sachent quoi tirer)
93101
git push -u origin
94102
95103
# La commande précédente vous affichera un lien pour ouvrir une pull request sur
@@ -360,9 +368,8 @@ Afin d'assurer la cohérence de nos traductions, voici quelques propositions et
360368
rappels pour les termes fréquents à traduire, n'hésitez pas à ouvrir un ticket
361369
si vous n'êtes pas d'accord.
362370

363-
Pour trouver facilement comment un terme est déjà traduit dans notre documentation,
364-
vous pouvez utiliser
365-
`find_in_po.py <https://gist.github.com/JulienPalard/c430ac23446da2081060ab17bf006ac1>`_.
371+
Pour trouver facilement comment un terme est déjà traduit dans notre
372+
documentation, vous pouvez utiliser `pogrep`_.
366373

367374
========================== ===============================================
368375
Terme Traduction proposée

0 commit comments

Comments
 (0)