Patch & Commission

Soumettre des patches

Les toutes premières fois que vous apportez des modifications au manuel, il est nécessaire de les soumettre en tant que patches pour que le responsable de la section les vise. C’est simplement pour s’assurer du maintien d’un manuel utilisateur de qualité, et que vous ne cassez pas accidentellement quelque chose de vital avant que vous ayez la maîtrise du 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 or 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 » avant que vous puissiez ajouter un titre et une description à vos modifications.

  5. Veuillez vérifier si le projet Documentation est désigné dans le champ de l’étiquette pour notifier l’équipe de votre patch. Vous pouvez aussi contacter l’équipe sur la mailing list ou le canal IRC.

  6. Ils vont réviser votre patch et vous faire savoir quelles modifications vous pouvez faire, ou commissionner le patch s’il est accepté.

Note

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

Des patches simples sont assurés d’être acceptés très rapidement. Une fois que vous êtes habitué à faire des modifications et n’avez plus besoin de retour, nous retirons la personne intermédiaire et vous donnons un accès direct pour éditer le manuel.

Commission directe

Au lieu de créer un fichier patch, la commission soumettra la modification 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.

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.