Patch & Commit

Soumettre des patches

Les premières fois que vous apporterez des modifications au manuel, vous devrez les soumettre sous forme de patches pour qu’un administrateur puisse les examiner. Ceci est juste pour s’assurer de la maintenance d’un manuel utilisateur de qualité, et que vous ne cassez pas accidentellement quelque chose d’essentiel avant de vous habituer au système.

Pour soumettre un patch, suivez cette procédure :

  1. Faites les modifications souhaitées.

  2. Créez un fichier patch en lançant la commande

    svn diff > filename.diff

    Ceci crée un simple fichier de texte qui montre quel texte a été ajouté, enlevé ou modifié par comparaison entre vos fichiers de travail et ceux du dépôt central.

    Si vous avez créé ou enlevé des fichiers, il est nécessaire de lancer svn add /path/to/file ou svn rm /path/to/file avant de créer le fichier diff. Pour voir la liste des fichiers impliqués, lancez svn status.

  3. Téléverser le fichier diff ici. Si vous n’avez pas déjà un compte, vous pouvez vous inscrire ici.

  4. Après la soumission du fichier diff, il vous est demandé de “Créer une nouvelle révision (Create a new Revision)” avant que vous puissiez ajouter un titre et une description à vos modifications.

  5. Veuillez vérifier si le projet Documentation est assigné dans le champ de l’étiquette pour notifier votre patch à l’équipe. Vous pouvez aussi contacter l’équipe sur la mailing list ou Blender Chat.

  6. Ils examineront votre patch et vous informeront de tout changement que vous pourriez y apporter. S’il n’y a pas de problème, votre patch sera accepté et ensuite commité par l’équipe de votre patch.

Note

Si votre patch comporte des modifications ou ajouts d’images, attachez-les simplement quand vous créez la révision.

Les patchs simples sont forcément acceptés très rapidement. Une fois que vous vous êtes habitué à faire des changements et que vous n’avez plus besoin de retour d’information, l’intermédiaire sera inutile et vous aurez un accès direct pour éditer le manuel.

Voir aussi

Voir Cycle de développement pour obtenir de la documentation sur la façon de faire des commits sur une branche de version spécifique et sur la façon de créer des commits de fusion.

Commission directe

Une fois que vous avez l’accès direct pour éditer le manuel, vous pouvez commencer à commiter directement au lieu de créer un fichier correctif. Cela vous permettra de soumettre les modifications directement à notre dépôt central.

Tout ce que vous avez à faire maintenant est de lancer la commande

svn commit -m "This is what I did"

Si vous oubliez -m 'message', il vous sera demandé de taper un message dans un éditeur de texte.

N’oubliez pas de toujours lancer svn update avant la commission.

Ensuite il vous sera demandé votre nom d’utilisateur (enregistré dans developer.blender.org) et votre mot de passe avant la commission de vos modifications.

Note

Assurez-vous d’utiliser votre nom d’utilisateur (sensible à la casse) et non votre adresse e-mail.

Vos fichiers modifiés sont téléversés dans le dépôt central pour que d’autres y travaillent et continuent à collaborer. Les commissions sont suivis dans les dépôts Diffusion . Peu de temps après, vos modifications seront visibles dans le manuel en ligne.

Écrire un bon message Commit

Lorsque vous apportez des modifications au manuel qui se rapportent directement à un commit spécifique (changement) dans Blender, il est utile de faire en sorte que le titre du commit soit le même que celui du commit fait dans Blender. Il est demandé d’inclure le hachage de validation de la validation effectuée dans le code source de Blender.

Par exemple, le commit rBM8473 inclut un descriptif indicatif des modifications apportées avec le hachage rBa71d2b260170. Le hachage peut être extrait de l’URL fournie dans la tâche de documentation pour une prochaine version spécifique.

D’autres modifications plus générales n’ont pas à suivre la politique ci-dessus, cependant, il est toujours important de clarifier la description des modifications que vous avez apportées et pourquoi. Il peut être utile de préfixer le titre du commit avec un mot de préfixe tel que Cleanup:` ou Fix:` lorsque vous effectuez respectivement des nettoyages ou des correctifs généraux.

La rédaction de bons messages de validation aide les administrateurs à suivre les modifications apportées et garantit que toutes les nouvelles fonctionnalités sont correctement documentées.