Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b4dfab6

Browse files
jeanasJulienPalard
authored andcommitted
Mise à jour du CONTRIBUTING.rst (#3)
closes #2 Co-authored-by: Jean Abou Samra <[email protected]> Reviewed-on: https://git.afpy.org/AFPy/python-docs-fr/pulls/3 Co-authored-by: jeanas <[email protected]> Co-committed-by: jeanas <[email protected]>
1 parent bb4000d commit b4dfab6

File tree

1 file changed

+64
-43
lines changed

1 file changed

+64
-43
lines changed

CONTRIBUTING.rst

Lines changed: 64 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -110,61 +110,51 @@ ce qui suit après vous être assuré que ``~/.local/bin/`` se trouve dans votre
110110
Pas d'inquiétude, cela ne change la façon dont Git affiche les changements que sur
111111
les fichiers de la traduction, sans incidence sur les autres.
112112
113+
.. _cloner:
114+
113115
Première étape : créer et peupler son dépôt
114116
===========================================
115117
116-
Sur Github
117-
----------
118-
119-
Depuis votre compte GitHub, se rendre dans le dépôt des sources `python-docs-fr
120-
<https://github.com/python/python-docs-fr>`_ puis cliquer sur son bouton ``Fork``.
121-
Ceci crée une copie du projet sur votre compte Github. C'est sur cette copie
122-
que vous avez le droit de faire des modifications.
123-
124-
Étape par étape :
118+
Si ce n'est pas déjà fait, créez un compte sur `le serveur Git de
119+
l'AFPy <https://git.afpy.org/>`_. Puis, allez sur le dépôt
120+
`python-docs-fr <https://git.afpy.org/AFPy/python-docs-fr>`_ et
121+
cliquez sur le bouton « Bifurcation » en haut à droite. Vous créez
122+
ainsi sur Gitea une copie privée du projet où vous avez le droit de
123+
faire des modifications.
124+
125+
À ce stade, il est recommandé, bien que facultatif, de vous créer une
126+
clé SSH si vous n'en avez pas encore, et de l'ajouter à votre compte
127+
Gitea. Pour générer la clé, consultez `le guide de GitLab
128+
<https://docs.gitlab.com/ee/user/ssh.html>`_ ou `celui de GitHub
129+
<https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/connecting-to-github-with-ssh>`_.
130+
Pour l'ajouter à votre compte Gitea, il suffit d'aller dans le menu de
131+
votre compte en haut à droite et de cliquer sur « Configuration »,
132+
puis d'aller dans l'onglet « Clés SSH / GPG », et de copier la clé
133+
SSH.
134+
135+
Si vous le préférez, vous pouvez également vous passer de cette
136+
configuration et utiliser le HTTPS à la place du SSH. Néanmoins,
137+
sachez que vous devrez taper votre nom d'utilisateur et votre mot de
138+
passe Gitea à chaque fois que vous ouvrez ou modifiez une
139+
contribution.
140+
141+
Enfin, faites une copie locale du dépôt sur votre ordinateur afin de
142+
pouvoir éditer les fichiers, avec ces commandes :
125143
126144
.. code-block:: bash
127145
128-
# Clonez votre fork Github avec `git` en utilisant ssh
129-
git clone git@github.com:VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git
146+
# Clonez votre copie sur Gitea avec `git` en utilisant SSH :
147+
git clone git@git.afpy.org:VOTRE_NOM_DE_COMPTE_GITEA/python-docs-fr.git
130148
131-
# ou bien avec HTTPS
132-
git clone https://github.com/VOTRE_NOM_DE_COMPTE_GITHUB/python-docs-fr.git
149+
# ... ou bien avec HTTPS :
150+
git clone https://git.afpy.org/VOTRE_NOM_DE_COMPTE_GITEA/python-docs-fr.git
133151
134152
# Allez dans le répertoire cloné
135153
cd python-docs-fr/
136154
137155
# Ajoutez le dépôt officiel (nommé upstream),
138-
# ceci permet à *git* de savoir quoi et où est *upstream*
139-
git remote add upstream https://github.com/python/python-docs-fr.git
140-
141-
142-
Sur une autre forge
143-
-------------------
144-
145-
Si vous n'avez pas de compte Github, il est possible d'utiliser une autre forge.
146-
Vous devez dans un premier temps initier un dépôt vide sur la forge où vous voulez héberger le
147-
dépôt puis le peupler.
148-
149-
Étape par étape :
150-
151-
.. code-block:: bash
152-
153-
# Clonez en HTTPS le dépôt
154-
git clone https://github.com/python/python-docs-fr
155-
156-
# Allez dans le répertoire cloné
157-
cd python-docs-fr/
158-
159-
# Renommez *origin* en *upstream* pour avoir une référence vers le dépôt officiel
160-
# Il permettra de récupérer les nouveaux commits
161-
git remote rename origin upstream
162-
163-
# Rajoutez le *remote* de votre forge (en HTTPS ou SSH)
164-
git remote add origin <url>
165-
166-
# Envoyez le dépôt sur votre forge et définir par défaut
167-
git push -u origin
156+
# ceci permet à `git` de savoir quoi et où est *upstream*
157+
git remote add upstream https://git.afpy.org/AFPy/python-docs-fr.git
168158
169159
170160
Deuxième étape : choisir et réserver le fichier sur lequel travailler
@@ -841,3 +831,34 @@ entre un paragraphe et sa traduction ; il faut passer outre ses avertissements.
841831
Vous pouvez aussi rajouter un commentaire dans le fichier *.po* pour avertir
842832
les traducteurs suivants et éviter qu'ils ne « corrigent » par erreur ces
843833
avertissements.
834+
835+
836+
837+
Migration vers Gitea
838+
====================
839+
840+
En novembre 2022, le dépôt de cette traduction a migré de GitHub à une
841+
instance de Gitea hébergée par l'AFPy. Si vous contribuiez auparavant
842+
sur GitHub, voici comment s'y prendre pour la migration :
843+
844+
- Suivez le guide `plus haut <cloner_>`_ pour faire une copie (*fork*)
845+
du dépôt sur Gitea. De manière facultative mais recommandée, ajoutez
846+
votre clé SSH à votre profil Gitea comme expliqué ci-dessus (vous
847+
aviez probablement une clé sur GitHub, auquel cas il suffit de
848+
réutiliser la même, qui doit se trouver dans le fichier
849+
``~/.ssh/id_ed25519.pub`` ou un nom similaire).
850+
851+
- Exécutez ces deux commandes pour mettre à jour votre dépôt local
852+
afin qu'il interagisse avec Gitea au lieu de GitHub :
853+
854+
.. code-block:: bash
855+
856+
git remote set-url upstream https://git.afpy.org/AFPy/python-docs-fr.git
857+
git remote set-url origin [email protected]:VOTRE_NOM_DE_COMPTE_GITEA/python-docs-fr.git
858+
859+
Si vous avez choisi d'utiliser le HTTPS à la place du SSH, remplacez
860+
la deuxième ligne par :
861+
862+
.. code-block:: bash
863+
864+
git remote set-url origin https://git.afpy.org/VOTRE_NOM_DE_COMPTE_GITEA/python-docs-fr.git

0 commit comments

Comments
 (0)