From eab389575dd0dd6c7dcaa6cb17bbac67ef3254f3 Mon Sep 17 00:00:00 2001 From: "Jules Lasne (jlasne - seluj78)" Date: Thu, 5 Dec 2019 18:01:04 +0100 Subject: [PATCH 1/6] Fixed typo in README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b6c0c7acb..8c2f92525 100644 --- a/README.rst +++ b/README.rst @@ -70,4 +70,4 @@ l'`AFPy `_. En 2017 ce projet est devenu la traduction officielle de la documentation Python en français grâce à la `PEP 545 `_. `Jules Lasne `_ à publié fin 2019 une `vidéo de -l'histore du repo `_. +l'histoire du repo `_. From 71c29b51282b3503797a54a5d78f2c409cea26fe Mon Sep 17 00:00:00 2001 From: "Jules Lasne (jlasne - seluj78)" Date: Thu, 5 Dec 2019 18:01:21 +0100 Subject: [PATCH 2/6] Separated code blocks Closes #1032 --- CONTRIBUTING.rst | 113 ++++++++++++++++++++++++++++++----------------- 1 file changed, 72 insertions(+), 41 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c24711a31..de3479b52 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -51,64 +51,94 @@ 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. + .. code-block:: bash - # 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. git fetch upstream - # On créé ensuite une branche. Il est pratique de nommer la branche en fonction du - # fichier sur lequel on travaille. Par exemple, si vous travaillez sur - # « library/sys.po », vous pouvez nommer votre branche « library-sys ». - # Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ». + +On créé ensuite une branche. Il est pratique de nommer la branche en fonction du +fichier sur lequel on travaille. Par exemple, si vous travaillez sur +« library/sys.po », vous pouvez nommer votre branche « library-sys ». +Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.8 ». + +.. code-block:: bash + git checkout -b library-sys upstream/3.8 - # Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit). - # N'oubliez pas de configurer votre nom et votre email dans Poedit. - # (É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. - # poedit library/sys.po ou lancez simplement poedit puis « Fichier » → « Ouvrir » - - # Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap` (voir la section *outils*) - # qui va reformater 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) : + +Vous pouvez maintenant travailler sur le fichier (typiquement, en utilisant poedit). +N'oubliez pas de configurer votre nom et votre email dans Poedit. +(É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. +poedit library/sys.po ou lancez simplement poedit puis « Fichier » → « Ouvrir » + +Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap` (voir la section *outils*) +qui va reformater 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) : + +.. code-block:: bash + 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 va lancer les vérifications nécessaires. + +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 va lancer les vérifications nécessaires. + +.. code-block:: bash + make verifs - # C'est le moment de git add et git commit - # git add va permettre de déplacer nos modifications dans l'index de Git en - # attendant d'être déplacée dans le dépôt local. + +C'est le moment de git add et git commit +git add va permettre de déplacer nos modifications dans l'index de Git en +attendant d'être déplacée dans le dépôt local. + +.. code-block:: bash + git add library/sys.po - # Puis on bascule les modifications dans le dépôt local avec un commit. + +Puis on bascule les modifications dans le dépôt local avec un commit. + +.. code-block:: bash + git commit -m "Traduction de library/sys.po" # Ou un autre message plus inspiré :) - # Poussez ensuite vos modifications sur votre fork Github. - # Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette - # branche est liée à votre fork Github (et donc que vos futurs `git pull` et - # `git push` sachent quoi tirer) + +Poussez ensuite vos modifications sur votre fork Github. +Le -u n'est utile qu'une fois pour que votre client git se souvienne que cette +branche est liée à votre fork Github (et donc que vos futurs `git pull` et +`git push` sachent quoi tirer) + +.. code-block:: bash + git push -u origin - # La commande précédente vous affichera un lien pour ouvrir une pull request sur - # Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls - # et un joli bouton « Compare & pull request » devrait apparaître au bout de - # quelques secondes vous indiquant que vous pouvez demander une pull request. - # À partir de là, quelqu'un passera en revue vos modifications, et vous fera des - # suggestions/corrections. 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) : +La commande précédente vous affichera un lien pour ouvrir une pull request sur +Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls +et un joli bouton « Compare & pull request » devrait apparaître au bout de +quelques secondes vous indiquant que vous pouvez demander une pull request. + +À partir de là, quelqu'un passera en revue vos modifications, et vous fera des +suggestions/corrections. 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) : + +.. code-block:: bash + git checkout library/sys git pull # pour rapatrier les modifications que vous auriez accepté # sur l'interface web. @@ -117,6 +147,7 @@ suivez cette procédure : git commit -a -m "prise en compte des remarques" git push + Vous avez peut-être remarqué que cela ressemble à un triangle, avec un segment manquant : From 5c5fd90f69e88f200cf4c6240bee4ab36d686f7d Mon Sep 17 00:00:00 2001 From: "Jules Lasne (jlasne)" Date: Tue, 3 Mar 2020 19:07:38 +0100 Subject: [PATCH 3/6] Apply suggestions from code review --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 21705fab5..8607ca5e7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -80,7 +80,7 @@ Vérifiez aussi qu'il est configuré pour passer à la ligne à 79 caractères. Ici, remplacez « library/sys.po » par le fichier que vous avez choisi précédemment. poedit library/sys.po ou lancez simplement poedit puis « Fichier » → « Ouvrir » -Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap` (voir la section *outils*) +Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap `_. (voir la section *outils*) qui va reformater 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) : From 575073911393906f34c9cd30a51c58fe5d26f0fb Mon Sep 17 00:00:00 2001 From: "Jules Lasne (jlasne)" Date: Tue, 3 Mar 2020 19:10:11 +0100 Subject: [PATCH 4/6] Update CONTRIBUTING.rst --- CONTRIBUTING.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8607ca5e7..b3802a3cf 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -78,7 +78,12 @@ 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. -poedit library/sys.po ou lancez simplement poedit puis « Fichier » → « Ouvrir » + +.. code-block:: bash + + poedit library/sys.po + +Ou lancez simplement poedit puis « Fichier » → « Ouvrir » Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap `_. (voir la section *outils*) qui va reformater correctement le fichier que avez vous avez modifié. From b2939cb80ce83aff0ecf39ee2274576b36ab97c9 Mon Sep 17 00:00:00 2001 From: "Jules Lasne (jlasne)" Date: Tue, 3 Mar 2020 19:12:03 +0100 Subject: [PATCH 5/6] Update CONTRIBUTING.rst --- CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b3802a3cf..fbe81ec19 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -135,6 +135,8 @@ 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 : Fixes #9999 où 9999 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/corrections. Pour les prendre en compte, retournez sur votre branche contenant du fichier concerné (au cas où vous auriez commencé quelque chose d'autre From 6fa30e973709b7426107a433271cefd578e7d6a6 Mon Sep 17 00:00:00 2001 From: Mathieu Dupuy Date: Sat, 2 May 2020 20:09:18 +0000 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com> --- CONTRIBUTING.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fbe81ec19..7c69347f4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -86,7 +86,7 @@ Ici, remplacez « library/sys.po » par le fichier que vous avez choisi préc Ou lancez simplement poedit puis « Fichier » → « Ouvrir » Si vous n'utilisez pas poedit, vous pouvez utiliser `powrap `_. (voir la section *outils*) -qui va reformater correctement le fichier que avez vous avez modifié. +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) : @@ -98,7 +98,7 @@ 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 va lancer les vérifications nécessaires. +La commande suivante lance les vérifications nécessaires. .. code-block:: bash @@ -106,15 +106,15 @@ La commande suivante va lancer les vérifications nécessaires. C'est le moment de git add et git commit -git add va permettre de déplacer nos modifications dans l'index de Git en -attendant d'être déplacée dans le dépôt local. +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 git add library/sys.po -Puis on bascule les modifications dans le dépôt local avec un commit. +Puis on propage les modifications dans le dépôt local avec un commit. .. code-block:: bash @@ -130,7 +130,7 @@ branche est liée à votre fork Github (et donc que vos futurs `git pull` et git push -u origin -La commande précédente vous affichera un lien pour ouvrir une pull request sur +La commande précédente vous affiche un lien pour ouvrir une pull request sur Github. Si vous l'avez manqué, allez simplement sur https://github.com/python/python-docs-fr/pulls et un joli bouton « Compare & pull request » devrait apparaître au bout de quelques secondes vous indiquant que vous pouvez demander une pull request.