@@ -7,16 +7,15 @@ Instructions
7
7
Prérequis
8
8
~~~~~~~~~
9
9
10
- - un compte `Github <https://github.com/join>`_ ;
11
- - un client ``git `` `Linux <https://git-scm.com/ >`_ ou `Windows <https://gitforwindows.org/>`_ ;
10
+ - un client ``git `` `Linux <https://git-scm.com/ >`_, `MacOS <https://git-scm.com/ >`_ ou `Windows <https://gitforwindows.org/>`_ ;
12
11
- un éditeur de fichier ``.po `` (comme `Poedit <https://poedit.net/ >`_).
13
12
14
13
Équipez-vous aussi de quelques outils pour vous aider dans
15
14
votre traduction (voir `Outils utiles pour la traduction `_).
16
15
17
16
18
- *fork * personnel
19
- ~~~~~~~~~~~~~~~~
17
+ *fork * personnel sur Github
18
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
19
21
20
Pour commencer vous aurez besoin de *forker * le dépôt des sources `python-docs-fr
22
21
<https://github.com/python/python-docs-fr> `_ en cliquant sur son bouton
@@ -41,47 +40,84 @@ où vous avez le droit de faire des modifications.
41
40
git remote add upstream https://github.com/python/python-docs-fr.git
42
41
43
42
43
+ *fork * personnel sur une autre forge
44
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
+
46
+ Si vous n'avez pas de compte Github, il est possible *fork * ce dépôt sur une autre forge.
47
+ Vous devez dans un premier temps initier un dépôt vide sur la forge où vous voulez héberger le
48
+ dépôt.
49
+
50
+ .. code-block :: bash
51
+
52
+ # Clonez en HTTPS le dépôt
53
+ git clone https://github.com/python/python-docs-fr
54
+
55
+ # Allez dans le répertoire cloné
56
+ cd python-docs-fr/
57
+
58
+ # Renommez *origin* en *upstream* pour avoir une référence vers le dépôt officiel
59
+ # Il permettra de récupérer les nouveaux commits
60
+ git remote rename origin upstream
61
+
62
+ # Rajoutez le *remote* de votre forge (en HTTPS ou SSH)
63
+ git remote add origin < url>
64
+
65
+ # Envoyez le dépôt sur votre forge et définir par défaut
66
+ git push -u origin
67
+
68
+
44
69
Réservation d'un fichier
45
70
~~~~~~~~~~~~~~~~~~~~~~~~
46
71
72
+ *Chaque fois que vous commencez un nouveau fichier, suivez cette procédure. *
73
+
47
74
Ensuite, vous devez trouver un fichier sur lequel travailler
48
75
(pour vous aiguiller, lisez la section `Que traduire ? `_). Nous vous conseillons
49
76
de choisir, si possible, un fichier traitant d'un sujet que vous maitrisez, cela
50
77
vous aidera grandement à produire une traduction de bonne qualité.
51
78
52
79
Si c'est votre première contribution, commencez par une toute petite
53
- PR , de quelques paragraphes maximum, pour vous familiariser. Il n'est
80
+ traduction , de quelques paragraphes maximum, pour vous familiariser. Il n'est
54
81
pas nécessaire de terminer un fichier lorsqu'on le commence, vous
55
82
pouvez donc prendre n'importe quel fichier, mais ne traduire que
56
83
quelques paragraphes.
57
84
58
- Une fois que vous avez choisi un fichier sur lequel travailler, veuillez
59
- ouvrir un `ticket sur Github <https://github.com/python/python-docs-fr/issues >`_
60
- en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po ``
61
- (par exemple « Je travaille sur library/sys.po »).
85
+ Une fois que vous avez choisi un fichier sur lequel travailler vous pouvez nous
86
+ le signaler par différents moyens :
87
+
88
+ * Soit en ouvrant un `ticket sur Github <https://github.com/python/python-docs-fr/issues >`_
89
+ en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po ``
90
+ (par exemple « Je travaille sur library/sys.po »).
91
+
62
92
Ceci permet à `potodo `_ de détecter via l'API Github les fichiers ``.po `` réservés
63
93
dans les tickets et les *pull requests *.
64
94
95
+ * Soit en créant un sujet sur le
96
+ `discuss de l'AFPy <https://discuss.afpy.org/ >`_ dans la section Traduction
97
+ en indiquant sur quoi vous travaillez et l'URL de votre dépôt.
98
+
99
+ * Soit sur IRC en venant sur le canal `#python-docs-fr <https://webchat.freenode.net/#python-docs-fr >`_ pour nous le signaler.
100
+
65
101
Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier,
66
102
suivez cette procédure :
67
103
68
- Pour travailler, nous aurons besoin d'une branche, basée sur une version à jour
69
- (fraîchement récupérée) de la branche upstream/3.9. On met donc à jour notre
104
+ Pour travailler, nous avons besoin d'une branche, basée sur une version à jour
105
+ (fraîchement récupérée) de la branche « upstream/3.9 » . On met donc à jour notre
70
106
version locale.
71
107
72
108
.. code-block :: bash
73
109
74
110
git fetch upstream
75
111
76
112
77
- On crée ensuite une branche. Il est pratique de nommer la branche en fonction du
113
+ On crée ensuite la branche, en la basant sur « upstream/3.9 », fraîchement récupérée.
114
+ Il est pratique de nommer cette branche en fonction du
78
115
fichier sur lequel on travaille. Par exemple, si vous travaillez sur
79
116
« library/sys.po », vous pouvez nommer votre branche « library-sys ».
80
- Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.9 ».
81
117
82
118
.. code-block :: bash
83
119
84
- git checkout --branch library-sys upstream/3.9
120
+ git checkout -b library-sys upstream/3.9
85
121
86
122
87
123
Vous pouvez maintenant travailler sur le fichier.
@@ -176,16 +212,17 @@ attendant d'être propagées dans le dépôt local.
176
212
177
213
178
214
179
- Poussez ensuite vos modifications sur votre *fork * Github avec ``git push ``.
215
+ Poussez ensuite vos modifications sur votre *fork * avec ``git push ``.
180
216
Le ``-u `` n'est utile qu'une fois pour que votre client git se souvienne que cette
181
- branche est liée à votre *fork * Github (et donc que vos futurs ``git pull `` et
217
+ branche est liée à votre *fork * (et donc que vos futurs ``git pull `` et
182
218
``git push `` sachent quoi tirer).
183
219
184
220
.. code-block :: bash
185
221
186
222
git push --set-upstream origin
187
223
188
-
224
+ Sur Github
225
+ ++++++++++
189
226
190
227
La commande précédente vous affiche un lien pour ouvrir une *pull request * sur
191
228
Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls
@@ -196,6 +233,26 @@ Mettez dans le commentaire de la *pull request* le texte suivant :
196
233
« Closes #XXXX » où XXXX est le numéro du ticket GitHub créé pour réserver le fichier traduit.
197
234
Cela permet à Github de lier la *pull request * au ticket de réservation.
198
235
236
+
237
+ Sur une autre forge
238
+ +++++++++++++++++++
239
+
240
+ Quand vous avez poussé vos modifications, il y a plusieurs possibilités.
241
+
242
+ Soit vous signalez via le `discuss de l'AFPy <https://discuss.afpy.org/ >`_ ou sur IRC que
243
+ vous avez traduit une section. Nous viendrons récupérer les modifications pour les intégrer
244
+ sur Github.
245
+
246
+ Soit en créant un *`bundle <https://git-scm.com/book/fr/v2/Utilitaires-Git-Empaquetage-bundling>`_ * Git,
247
+ pour cela, il faut créer un fichier contenant les différentes modifications effectuées.
248
+
249
+ .. code-block :: bash
250
+
251
+ git bundle create < name> .bundle < commit_id1> ..< commit_id2>
252
+
253
+ Puis nous partager ce *bundle * sur le `discuss de l'AFPy <https://discuss.afpy.org/ >`_ pour pouvoir l'intégrer.
254
+
255
+
199
256
À partir de là, quelqu'un passera en revue vos modifications, et vous fera des
200
257
suggestions et corrections. Pour les prendre en compte, retournez sur votre branche
201
258
contenant le fichier concerné (au cas où vous auriez commencé quelque chose d'autre
@@ -234,6 +291,7 @@ Si nécessaire, les traductions seraient rétroportées sur les versions
234
291
les plus anciennes par l'`équipe de documentation
235
292
<https://www.python.org/dev/peps/pep-8015/#documentation-team> `_.
236
293
294
+
237
295
Que traduire ?
238
296
--------------
239
297
@@ -445,28 +503,28 @@ parameter paramètre
445
503
pickle (v.) sérialiser
446
504
prompt invite
447
505
raise lever
448
- roughly approximativement, à peu près (on ne traduit pas
449
- « roughly equivalent » par « sensiblement équivalent »)
450
506
regular expression expression rationnelle, expression régulière
451
507
return renvoie, donne (on évite « retourne » qui
452
508
pourrait porter à confusion)
509
+ roughly approximativement, à peu près (on ne traduit pas
510
+ « roughly equivalent » par « sensiblement équivalent »)
453
511
setter mutateur
454
512
simple quote guillemet simple
455
513
socket connecteur ou interface de connexion
514
+ specify définir, préciser (plutôt que « spécifier »)
456
515
statement instruction
457
516
subprocess sous-processus
458
517
support prendre en charge, implémenter (« supporter »
459
518
n'a pas le même sens en français)
460
- specify définir, préciser (plutôt que « spécifier »)
461
- typically normalement, habituellement, comme d'habitude
462
- (plutôt que « typiquement »)
463
519
thread fil d'exécution
464
520
traceback trace d'appels, trace de pile
465
521
tuple *n *-uplet (avec *n * en italique), on peut
466
522
traduire *2-tuple * par « paire » ou « couple »,
467
523
*3-tuple * par « triplet », *4-tuple * par
468
524
« quadruplet » etc.
469
- underscore tiret bas, *underscore *
525
+ typically normalement, habituellement, comme d'habitude
526
+ (plutôt que « typiquement »)
527
+ underscore tiret bas, *underscore *, sous-tiret
470
528
whitespace caractère d'espacement
471
529
========================== ===============================================
472
530
@@ -684,19 +742,19 @@ Powrap
684
742
| `Lien vers le dépôt <https://github.com/JulienPalard/powrap>`__
685
743
686
744
687
- Simplification des diffs git
688
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
745
+ Affichage des modifications par Git
746
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
689
747
690
- Les diffs git sont souvent encombrés de changements inutiles de numéros
748
+ Le résultat de `` git diff `` est souvent encombré de changements inutiles de numéros
691
749
de ligne, comme :
692
750
693
751
.. code-block :: diff
694
752
695
- -#: ../Doc/library/signal .rst:406
696
- +#: ../Doc/library/signal .rst:408
753
+ -#: ../Doc/library/sys .rst:406
754
+ +#: ../Doc/library/sys .rst:408
697
755
698
756
699
- Pour dire à git que ce ne sont pas des informations utiles, vous pouvez faire
757
+ Pour dire à Git que ce ne sont pas des informations utiles, vous pouvez faire
700
758
ce qui suit après vous être assuré que ``~/.local/bin/ `` se trouve dans votre
701
759
``PATH ``.
702
760
0 commit comments