1
1
Guide de contribution à la documention via GitHub.
2
2
===================================================
3
3
4
- Prérequis :
5
- ------------
4
+ Prérequis
5
+ ---------
6
6
7
7
- Un compte `Github <https://github.com/join >`_.
8
8
- ``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.
35
35
git remote add upstream https://github.com/python/python-docs-fr.git
36
36
37
37
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é).
39
41
40
42
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»).
43
46
Ceci permet à `potodo `_ de détecter via l'API Github les fichiers ``.po `` réservés
44
47
dans les tickets et les *pull requests *.
45
48
46
49
N'hésitez pas non plus à vous équiper de quelques outils pour vous aider dans
47
50
votre traduction (voir `Outils utiles pour la traduction `_)
48
51
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 :
51
54
52
55
.. code-block :: bash
53
56
@@ -58,14 +61,16 @@ fois que vous commencerez un nouveau fichier, commencez ainsi :
58
61
59
62
# On créé ensuite une branche. Il est pratique de nommer la branche en fonction du
60
63
# 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 ».
62
65
# Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ».
63
66
git checkout -b library-sys upstream/3.8
64
67
65
68
# Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit).
66
69
# N'oubliez pas de configurer poedit pour passer à la ligne à 79 caractères.
67
70
# (É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.
69
74
poedit library/sys.po
70
75
71
76
# 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 :
78
83
# de noms propres, comme « Guido », « C99 » ou « sérialisable », est
79
84
# stockée dans le fichier « dict » à la racine du projet. Vous pouvez
80
85
# bien sûr y ajouter une entrée si nécessaire.
86
+ # La commande suivante va lancer les vérifications nécessaires.
81
87
make verifs
82
88
83
89
# 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.
85
92
git add library/sys.po
86
93
94
+ # Puis on bascule les modifications dans le dépôt local avec un commit.
87
95
git commit -m " Traduction de library/sys.po" # Ou un autre message plus inspiré :)
88
96
89
97
# Poussez ensuite vos modifications sur votre fork Github.
90
98
# 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)
93
101
git push -u origin
94
102
95
103
# 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
360
368
rappels pour les termes fréquents à traduire, n'hésitez pas à ouvrir un ticket
361
369
si vous n'êtes pas d'accord.
362
370
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 `_.
366
373
367
374
========================== ===============================================
368
375
Terme Traduction proposée
0 commit comments