From b616714f7b83c5f64d4e587246c8ceb98e477cf1 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 23 Dec 2020 19:14:48 +0100 Subject: [PATCH 1/7] =?UTF-8?q?Contribution=20ext=C3=A9rieur?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 81 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 68 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 437f7c4d3..fb550ca08 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -7,16 +7,15 @@ Instructions Prérequis ~~~~~~~~~ -- un compte `Github `_ ; -- un client ``git`` `Linux `_ ou `Windows `_ ; +- un client ``git`` `Linux `_, `MacOS `_ ou `Windows `_ ; - un éditeur de fichier ``.po`` (comme `Poedit `_). Équipez-vous aussi de quelques outils pour vous aider dans votre traduction (voir `Outils utiles pour la traduction`_). -*fork* personnel -~~~~~~~~~~~~~~~~ +*fork* personnel sur Github +~~~~~~~~~~~~~~~~~~~~~~~~~~~ Pour commencer vous aurez besoin de *forker* le dépôt des sources `python-docs-fr `_ en cliquant sur son bouton @@ -41,6 +40,32 @@ où vous avez le droit de faire des modifications. git remote add upstream https://github.com/python/python-docs-fr.git +*fork* personnel sur une autre forge +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Si vous n'avez pas de compte Github, il est possible *fork* ce dépôt sur une autre forge. +Vous devez dans un premier initier un dépôt vide sur la forge où vous voulez héberger le +dépôt. + +.. code-block:: bash + + # Clonez en HTTP le dépôt + git clone https://github.com/python/python-docs-fr + + # Allez dans le répertoire cloné + cd python-docs-fr/ + + # Renommez *origin* en *upstream* pour avoir une référence vers le dépôt officiel + # Il permettra de récupérer les nouveaux commit + git remote rename origin upstream + + # Rajoutez le *remote* de votre forge (en HTTP ou SSH) + git remote add origin + + # Envoyez le dépôt sur votre forge et définir par défaut + git push -u origin + + Réservation d'un fichier ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -50,18 +75,26 @@ de choisir, si possible, un fichier traitant d'un sujet que vous maitrisez, cela vous aidera grandement à produire une traduction de bonne qualité. Si c'est votre première contribution, commencez par une toute petite -PR, de quelques paragraphes maximum, pour vous familiariser. Il n'est +*pull request*, de quelques paragraphes maximum, pour vous familiariser. Il n'est pas nécessaire de terminer un fichier lorsqu'on le commence, vous pouvez donc prendre n'importe quel fichier, mais ne traduire que quelques paragraphes. -Une fois que vous avez choisi un fichier sur lequel travailler, veuillez -ouvrir un `ticket sur Github `_ -en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po`` -(par exemple « Je travaille sur library/sys.po »). +Une fois que vous avez choisi un fichier sur lequel travailler vous pouvez signaler +par différents moyens : + +* Soit en ouvrant un `ticket sur Github `_ + en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po`` + (par exemple « Je travaille sur library/sys.po »). + Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés dans les tickets et les *pull requests*. +* Soit en créant un sujet sur le `discuss de l'AFPy `_ dans la section Traduction en + indiquant sur quoi vous travaillez et l'URL de votre dépôt. + +* Soit sur IRC en venant sur le canal #python-docs-fr pour nous le signaler. + Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier, suivez cette procédure : @@ -176,16 +209,17 @@ attendant d'être propagées dans le dépôt local. -Poussez ensuite vos modifications sur votre *fork* Github avec ``git push``. +Poussez ensuite vos modifications sur votre *fork* avec ``git push``. 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 +branche est liée à votre *fork* (et donc que vos futurs ``git pull`` et ``git push`` sachent quoi tirer). .. code-block:: bash git push --set-upstream origin - +Sur Github +++++++++++ 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 @@ -196,6 +230,26 @@ Mettez dans le commentaire de la *pull request* le texte suivant : « Closes #XXXX » où XXXX est le numéro du ticket GitHub créé pour réserver le fichier traduit. Cela permet à Github de lier la *pull request* au ticket de réservation. + +Sur une autre forge ++++++++++++++++++++ + +Quand vous avez poussé vos modifications, il y a plusieurs possibilité. + +Soit vous signalez via le `discuss de l'AFPy `_ ou sur IRC que +vous avez traduit une section. Puis nous viendrons récupérer les modifications pour les intégrer +sur Github. + +Soit en créant un `*bundle* `_ Git, +pour cela, il faut créer un fichier contenant les différentes modifications effectué. + +.. code-block:: bash + + git bundle create .bundle .. + +Puis nous partager ce *bundle* sur le `discuss de l'AFPy `_ pour pouvoir l'intégrer. + + À partir de là, quelqu'un passera en revue vos modifications, et vous fera des suggestions et corrections. Pour les prendre en compte, retournez sur votre branche contenant le fichier concerné (au cas où vous auriez commencé quelque chose d'autre @@ -234,6 +288,7 @@ Si nécessaire, les traductions seraient rétroportées sur les versions les plus anciennes par l'`équipe de documentation `_. + Que traduire ? -------------- @@ -461,7 +516,7 @@ typically normalement, habituellement, comme d'habitude thread fil d'exécution traceback trace d'appels, trace de pile tuple n-uplet -underscore tiret bas, *underscore* +underscore tiret bas, *underscore*, sous-tiret whitespace caractère d'espacement ========================== =============================================== From 7095ade36bcbb2133e83fc2f0819cbccda811dd9 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 23 Dec 2020 19:21:11 +0100 Subject: [PATCH 2/7] Correction --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fb550ca08..6e095c3b5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,7 +93,7 @@ dans les tickets et les *pull requests*. * Soit en créant un sujet sur le `discuss de l'AFPy `_ dans la section Traduction en indiquant sur quoi vous travaillez et l'URL de votre dépôt. -* Soit sur IRC en venant sur le canal #python-docs-fr pour nous le signaler. +* Soit sur IRC en venant sur le canal `#python-docs-fr `_ pour nous le signaler. Vous êtes maintenant prêt. Chaque fois que vous commencerez un nouveau fichier, suivez cette procédure : @@ -240,7 +240,7 @@ Soit vous signalez via le `discuss de l'AFPy `_ ou su vous avez traduit une section. Puis nous viendrons récupérer les modifications pour les intégrer sur Github. -Soit en créant un `*bundle* `_ Git, +Soit en créant un *`bundle `_* Git, pour cela, il faut créer un fichier contenant les différentes modifications effectué. .. code-block:: bash From 49f9779327bd8b240d910156c9ecc64c76512553 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 23 Dec 2020 19:31:41 +0100 Subject: [PATCH 3/7] Temps Les mots, c'est important ! --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6e095c3b5..c2cf50d16 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -44,7 +44,7 @@ où vous avez le droit de faire des modifications. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Si vous n'avez pas de compte Github, il est possible *fork* ce dépôt sur une autre forge. -Vous devez dans un premier initier un dépôt vide sur la forge où vous voulez héberger le +Vous devez dans un premier temps initier un dépôt vide sur la forge où vous voulez héberger le dépôt. .. code-block:: bash From a5a32b9b1b21bc07d858876adb1b91461ce0efc5 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 27 Jan 2021 20:40:37 +0100 Subject: [PATCH 4/7] Line break --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c2cf50d16..d5f479820 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -75,8 +75,8 @@ de choisir, si possible, un fichier traitant d'un sujet que vous maitrisez, cela vous aidera grandement à produire une traduction de bonne qualité. Si c'est votre première contribution, commencez par une toute petite -*pull request*, de quelques paragraphes maximum, pour vous familiariser. Il n'est -pas nécessaire de terminer un fichier lorsqu'on le commence, vous +*pull request*, de quelques paragraphes maximum, pour vous familiariser. +Il n'est pas nécessaire de terminer un fichier lorsqu'on le commence, vous pouvez donc prendre n'importe quel fichier, mais ne traduire que quelques paragraphes. From 886cbf3a57460b90459fef0913c084b5f2cdc629 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 27 Jan 2021 20:42:09 +0100 Subject: [PATCH 5/7] line break 2 --- CONTRIBUTING.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d5f479820..b4d62cda8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -90,8 +90,9 @@ par différents moyens : Ceci permet à `potodo`_ de détecter via l'API Github les fichiers ``.po`` réservés dans les tickets et les *pull requests*. -* Soit en créant un sujet sur le `discuss de l'AFPy `_ dans la section Traduction en - indiquant sur quoi vous travaillez et l'URL de votre dépôt. +* Soit en créant un sujet sur le + `discuss de l'AFPy `_ dans la section Traduction + en indiquant sur quoi vous travaillez et l'URL de votre dépôt. * Soit sur IRC en venant sur le canal `#python-docs-fr `_ pour nous le signaler. From 923ec8c2048d73afe1980cbd0352690d0c78d085 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 27 Jan 2021 20:51:17 +0100 Subject: [PATCH 6/7] =?UTF-8?q?Avec=20un=20=C2=AB=20s=20=C2=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b4d62cda8..33784796c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -49,17 +49,17 @@ dépôt. .. code-block:: bash - # Clonez en HTTP le dépôt + # Clonez en HTTPS le dépôt git clone https://github.com/python/python-docs-fr # Allez dans le répertoire cloné cd python-docs-fr/ # Renommez *origin* en *upstream* pour avoir une référence vers le dépôt officiel - # Il permettra de récupérer les nouveaux commit + # Il permettra de récupérer les nouveaux commits git remote rename origin upstream - # Rajoutez le *remote* de votre forge (en HTTP ou SSH) + # Rajoutez le *remote* de votre forge (en HTTPS ou SSH) git remote add origin # Envoyez le dépôt sur votre forge et définir par défaut From 4e2701c303a3865d7d3915756b40b7a9aac35ea5 Mon Sep 17 00:00:00 2001 From: HS-157 Date: Wed, 27 Jan 2021 21:02:44 +0100 Subject: [PATCH 7/7] Relecture --- CONTRIBUTING.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 33784796c..22366dad2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -80,8 +80,8 @@ Il n'est pas nécessaire de terminer un fichier lorsqu'on le commence, vous pouvez donc prendre n'importe quel fichier, mais ne traduire que quelques paragraphes. -Une fois que vous avez choisi un fichier sur lequel travailler vous pouvez signaler -par différents moyens : +Une fois que vous avez choisi un fichier sur lequel travailler vous pouvez nous +le signaler par différents moyens : * Soit en ouvrant un `ticket sur Github `_ en indiquant dans le titre ``Je travaille sur DOSSIER/FICHIER.po`` @@ -235,14 +235,14 @@ Cela permet à Github de lier la *pull request* au ticket de réservation. Sur une autre forge +++++++++++++++++++ -Quand vous avez poussé vos modifications, il y a plusieurs possibilité. +Quand vous avez poussé vos modifications, il y a plusieurs possibilités. Soit vous signalez via le `discuss de l'AFPy `_ ou sur IRC que -vous avez traduit une section. Puis nous viendrons récupérer les modifications pour les intégrer +vous avez traduit une section. Nous viendrons récupérer les modifications pour les intégrer sur Github. Soit en créant un *`bundle `_* Git, -pour cela, il faut créer un fichier contenant les différentes modifications effectué. +pour cela, il faut créer un fichier contenant les différentes modifications effectuées. .. code-block:: bash