Pull Requests

Cette page décrit les outils utilisés pour la contribution et la révision du code.

Les révisions sont une mesure clé pour garantir que les changements sont de bonne qualité. Elles aident à prévenir les bogues, les incohérences de conception ou les problèmes de maintenance potentiels. Et faire examiner votre travail vous maintient également généralement sur vos gardes.

Note

Les rédacteurs à qui on a accordé le droit peuvent commiter dans le dépôt principal sans avoir besoin de le forker.

Voir Recommandations pour le Commit si cela vous concerne.

One Time Setup

Cela suppose que vous avez déjà extrait (checkout) le dépôt du manuel de Blender sur votre ordinateur, en suivant les instructions d’installation.

Fork

  1. Accédez au dépôt Blender et cliquez sur le bouton Fork.

  2. Confirmez le fork avec les paramètres par défaut.

  3. Vous devrez maintenant ajouter votre fork personnel en tant que distant (remote) dans votre dépôt git local. Cliquez sur SSH pour voir l’URL correcte, puis ajoutez-la comme ceci :

    git remote add me [email protected]:<USERNAME>/blender-manual.git

Note

Pour pousser (push) vers le fork du dépôt, vous avez besoin d’une clé SSH. Si vous n’avez pas déjà le fichier ~/.ssh/id_rsa.pub, il existe une commande simple pour générer de telles clés qui fonctionne sous Linux, macOS et dans Git Bash sous Windows :

ssh-keygen

Cette commande générera une clé privée id_rsa et une clé publique id_rsa.pub dans ~/.ssh. La clé privée ne doit jamais être montrée ou envoyée à quelqu’un d’autre pour éviter de compromettre votre compte, mais la clé publique peut être partagée en toute sécurité.

Le contenu de ~/.ssh/id_rsa.pub peut être copié et collé dans les paramètres du compte surprojects.blender.org, après avoir cliqué sur “Add Key”. N’importe quel nom est acceptable pour la clé SSH.

Flux de travail

Le flux de travail pour travailler avec les demandes d’extraction (pull requests) peut être trouvé sur le wiki du développeur Blender.

Notez qu’une partie du texte des instructions ci-dessus se concentre sur le référentiel principal de Blender, cependant, le flux de travail est le même pour n’importe quel projet Blender.

Lignes directrices pour les réviseurs

  • Le texte de la pull request doit être utilisable comme message de commit git (voir les directives pour plus de détails).

  • Soyez explicite lorsque certains changements doivent être apportés avant de commiter, sans avoir besoin d’une itération de révision.

  • Si la demande d’extraction (pull request) n’est pas approuvée, l’auteur doit effectuer une autre itération.

  • Si le changement nécessite d’abord un accord sur la tâche de conception, mettez la demande d’extraction en attente en ajoutant un préfixe WIP: dans le titre, indiquant que l’auteur considère que la demande d’extraction n’est pas prête à être fusionnée. Aucune critique n’est attendue à moins que l’auteur ne le demande spécifiquement.

  • Les rédacteurs doivent répondre aux demandes de pull requests dans les 3 jours ouvrables.

  • Ajoutez des modules/projets pertinents aux étiquettes (tags).

  • Encouragez les nouveaux rédacteurs à faire des révisions, c’est un bon moyen d’apprendre et c’est important pour le développement du projet.

Astuces

  • Pour obtenir le fichier de correctif, ajoutez .patch à la fin de l’URL de la demande d’extraction. Exemple :

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • Extrayez (Checkout) une pull request dans une tête détachée (sans laisser de branche). Exemple :

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD