8000 Readme contributing typos + code blocks changes (#1039) · python/python-docs-fr@939285b · GitHub
[go: up one dir, main page]

Skip to content

Commit 939285b

Browse files
Seluj78deronnaxchristopheNan
authored
Readme contributing typos + code blocks changes (#1039)
* Fixed typo in README.rst * Separated code blocks Closes #1032 * Apply suggestions from code review * Update CONTRIBUTING.rst * Apply suggestions from code review Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com> Co-authored-by: Mathieu Dupuy <deronnax@users.noreply.github.com> Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
1 parent 3d088ca commit 939285b

File tree

2 files changed

+78
-42
lines changed

2 files changed

+78
-42
lines changed

CONTRIBUTING.rst

Lines changed: 77 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -51,64 +51,99 @@ votre traduction (voir `Outils utiles pour la traduction`_)
5151
Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier,
5252
suivez cette procédure :
5353

54+
55+
Pour travailler, nous aurons besoin d'une branche, basée sur une version à jour
56+
(fraîchement récupérée) de la branche upstream/3.8. On met donc à jour notre
57+
version locale.
58+
5459
.. code-block:: bash
5560
56-
# Pour travailler, nous aurons besoin d'une branche, basée sur une version à jour
57-
# (fraîchement récupérée) de la branche upstream/3.8. On met donc à jour notre
58-
# version locale.
5961
git fetch upstream
6062
61-
# On créé ensuite une branche. Il est pratique de nommer la branche en fonction du
62-
# fichier sur lequel on travaille. Par exemple, si vous travaillez sur
63-
# « library/sys.po », vous pouvez nommer votre branche « library-sys ».
64-
# Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ».
63+
64+
On créé ensuite une branche. Il est pratique de nommer la branche en fonction du
65+
fichier sur lequel on travaille. Par exemple, si vous travaillez sur
66+
« library/sys.po », vous pouvez nommer votre branche « library-sys ».
67+
Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ».
68+
69+
.. code-block:: bash
70+
6571
git checkout -b library-sys upstream/3.8
6672
67-
# Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit).
68-
# N'oubliez pas de configurer votre nom et votre email dans Poedit.
69-
# (Édition -> Préférences -> Général)
70-
# Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères.
71-
# (Édition -> Préférences -> Avancé -> Passer à la ligne à : 79)
72-
#
73-
# Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment.
74-
# poedit library/sys.po ou lancez simplement poedit puis « Fichier » → « Ouvrir »
75-
76-
# Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap` (voir la section *outils*)
77-
# qui va reformater correctement le fichier que avez vous avez modifié.
78-
# Exécutez `powrap -m` (reformater tous les fichiers modifiés)
79-
# ou `powrap library/sys.po` (un fichier en particulier) :
73+
74+
Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit).
75+
N'oubliez pas de configurer votre nom et votre email dans Poedit.
76+
(Édition -> Préférences -> Général)
77+
Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères.
78+
(Édition -> Préférences -> Avancé -> Passer à la ligne à : 79)
79+
80+
Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment.
81+
82+
.. code-block:: bash
83+
84+
poedit library/sys.po
85+
86+
Ou lancez simplement poedit puis « Fichier » → « Ouvrir »
87+
88+
Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap <https://github.com/JulienPalard/powrap>`_. (voir la section *outils*)
89+
qui reformate correctement le fichier que avez vous avez modifié.
90+
Exécutez `powrap -m` (reformater tous les fichiers modifiés)
91+
ou `powrap library/sys.po` (un fichier en particulier) :
92+
93+
.. code-block:: bash
94+
8095
powrap -m
8196
82-
# Pour l'orthographe, une liste blanche de certains termes techniques ou
83-
# de noms propres, comme « Guido », « C99 » ou « sérialisable », est
84-
# stockée dans le fichier « dict » à la racine du projet. Vous pouvez
85-
# bien sûr y ajouter une entrée si nécessaire.
86-
# La commande suivante va lancer les vérifications nécessaires.
97+
Pour l'orthographe, une liste blanche de certains termes techniques ou
98+
de noms propres, comme « Guido », « C99 » ou « sérialisable », est
99+
stockée dans le fichier « dict » à la racine du projet. Vous pouvez
100+
bien sûr y ajouter une entrée si nécessaire.
101+
La commande suivante lance les vérifications nécessaires.
102+
103+
.. code-block:: bash
104+
87105
make verifs
88106
89-
# C'est le moment de git add et git commit.
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.
107+
108+
C'est le moment de git add et git commit
109+
git add place nos modifications dans l'index de Git en
110+
attendant d'être propagées dans le dépôt local.
111+
112+
.. code-block:: bash
113+
92114
git add library/sys.po
93115
94-
# Puis on bascule les modifications dans le dépôt local avec un commit.
116+
117+
Puis on propage les modifications dans le dépôt local avec un commit.
118+
119+
.. code-block:: bash
120+
95121
git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :)
96122
97-
# Poussez ensuite vos modifications sur votre fork Github.
98-
# Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette
99-
# branche est liée à votre fork Github (et donc que vos futurs `git pull` et
100-
# `git push` sachent quoi tirer)
123+
124+
Poussez ensuite vos modifications sur votre fork Github.
125+
Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette
126+
branche est liée à votre fork Github (et donc que vos futurs `git pull` et
127+
`git push` sachent quoi tirer)
128+
129+
.. code-block:: bash
130+
101131
git push -u origin
102132
103-
# La commande précédente vous affichera un lien pour ouvrir une pull request sur
104-
# Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls
105-
# et un joli bouton « Compare & pull request » devrait apparaître au bout de
106-
# quelques secondes vous indiquant que vous pouvez demander une pull request.
133+
La commande précédente vous affiche un lien pour ouvrir une pull request sur
134+
Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls
135+
et un joli bouton « Compare & pull request » devrait apparaître au bout de
136+
quelques secondes vous indiquant que vous pouvez demander une pull request.
137+
138+
Mettez dans le commentaire de la pull request le texte suivant : Fixes #9999 où 9999 est le numéro du ticket GitHub créé pour réserver le fichier traduit.
139+
140+
À partir de là, quelqu'un passera en revue vos modifications, et vous fera des
141+
suggestions/corrections. Pour les prendre en compte, retournez sur votre branche
142+
contenant du fichier concerné (au cas où vous auriez commencé quelque chose d'autre
143+
sur une autre branche) :
144+
145+
.. code-block:: bash
107146
108-
# À partir de là, quelqu'un passera en revue vos modifications, et vous fera des
109-
# suggestions-corrections. Pour les prendre en compte, retournez sur votre branche
110-
# contenant du fichier concerné (au cas où vous auriez commencé quelque chose d'autre
111-
# sur une autre branche) :
112147
git checkout library/sys
113148
git pull # pour rapatrier les modifications que vous auriez acceptées
114149
# sur l'interface web.
@@ -117,6 +152,7 @@ suivez cette procédure :
117152
git commit -a -m "prise en compte des remarques"
118153
git push
119154
155+
120156
Vous avez peut-être remarqué que cela ressemble à un triangle, avec un
121157
segment manquant :
122158

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ l'`AFPy <https://www.afpy.org/>`_. En 2017 ce projet est devenu la
7070
traduction officielle de la documentation Python en français grâce à
7171
la `PEP 545 <https://www.python.org/dev/peps/pep-0545/>`_. `Jules Lasne
7272
<https://github.com/Seluj78>`_ à publié fin 2019 une `vidéo de
73-
l'histoire du dépôt <https://youtu.be/azXmvpEJMhU>`_.
73+
l'histoire du dépôt <https://youtu.be/azXmvpEJMhU>`_.

0 commit comments

Comments
 (0)
0