Table des matières

Collaborer sur le dépôt bpyNel workbench - OpenNeL legacy

Cette page n’est conservée que pour des raisons historiques. Il n’y a plus lieu de collaborer à ce dépôt.

Ce dépôt est celui qui contient le(s) plugin(s) qui feront de Blender 2.8 notre éditeur de jeu. Il se sert de la bibliothèque de composants développée dans Collaborer sur le dépôt pyNeL.

L’interface du plugin doit se faire en suivant les indications données pour Blender 2.8 : 2.8: Addons UI

Plugins

NeL Object Import - io_nel_import

Le workflow de travail

Mise en place d'un dépôt personnel (fork)

Pour commencer, il vous faudra forker le dépôt principal. Ainsi, vous aurez votre propre dépôt, sur lequel vous pourrez effectuer vos modifications sans interférer avec le dépôt principal.

Pour cela, il vous suffit de cliquer sur le bouton suivant sur la page d’accueil du projet.

Vous serez alors redirigée vers votre copie du dépôt.

Travailler directement sur le dépôt principal

Si vous êtes une développeuse “officielle” (avec une autorisation d'accès dans le groupe Khaganat) chez nous, vous aurez accès au dépôt principal sur notre GitLab : bpyNel workbench.

Vous n'aurez pas à créer un dépôt personnel (sauf si vous en avez envie) pour pouvoir contribuer, il vous suffira de travailler sur des branches en interne.

Le dépôt et ses branches

Khanat utilise un workflow inspiré de Gitflow. De ce fait, il y a deux types de branches : principales et temporaires.

Les branches principales sont :

À cela s'ajoutent des branches temporaires, ouvertes et fermées suivant les besoins:

Les branches, que ce soit sur votre fork ou sur les dépôts officiels, doivent être nommées de la façon suivante:

Publication d'une feature

Une fois que vous considérez la feature que vous avez développé terminée, vous pouvez créer une Merge Request, à destination de Develop. Cette requête doit respecter ces impératifs :

Publication d'une release

Une fois un certain nombre de features mergé avec Develop, nous créons une nouvelle branche release. À partir de ce moment, seuls les bugfix sont acceptés (code freeze).

Une fois le nouveau code testé, et les bugs corrigés, la release est taguée, et publiée dans master.

Créer un HotFix

Il arrive que des bugs critiques passent à travers les maillons du filet de la QA, c'est pourquoi il est parfois nécessaire de faire des “hotfix” (correction à chaud).

Pour cela, il faut faire une branche “hotfix” depuis master, y corriger le bug, puis le publier dans master.

Gestion des Merge Request

Lorsqu'on a terminé une Feature, il faut faire une demande de Merge Request en expliquant en quoi la tâche est terminée et l'affecter à une autre personne même si on a la capacité de merger directement.

Cela permettra d'avoir un contrôle, ne serait-ce que formel, sur l'ajout.

On ne merge jamais soi-même directement sur Master.

Gestion des Issues

De préférence à la base TAF, créez les demandes d'ajout de features sur le système Gitlab de ce dépôt. Bien évidement, les Bugs liés à la programmation sont à signaler ici également.

De même, avant de commencer une tâche, créez une Issue que vous vous attribuez, comme ça vous pouvez numéroter la branche correctement et on sait que quelqu'un a commencé à travailler sur ce sujet.

Les travaux à faire, modifications de fichier, créations, doivent être indiquées en se servant du système d'Issues de ce dépôt : Issue sur bpyNel workbench

Il suffit de cliquer sur :

Vous renseignez ensuite les différents champs.

Le titre doit être concis et le plus explicite possible.
Par contre, n'hésitez pas à être le plus précis possible dans la zone Description.

Il y a ensuite 3 zones de champs à renseigner :

Dans le doute, n'indiquez rien dans ces quatre champs. De toute façon, tout est éditable a posteriori donc ce n'est pas grave si vous faites des erreurs ou n'êtes pas assez précis.

Gestion des Milestones

On se servira des mêmes milestones que pour les autres dépôts et secteurs de développement du projet, présentés sur la page milestones.

Gestion des Tags

Nous n'utilisons pas de Tags sur ce dépôt Git pour le moment.

Gestion des Labels

Les Labels doivent être génériques et permettre ainsi de regrouper par genre de compétence. Il est possible d'en créer lors de la génération d'une Issue si aucune ne convient mais cela peut être fait par la suite, surtout quand on est indécis.