Ceci est une ancienne révision du document !
Collaborer sur khanat-sound-source
WIP
Le workflow de travail
Mise en place d'un dépôt personnel (fork)
Cet étape n'est pas utile aux développeurs khanat officiels, qui ont directement accès au dépôt, et peuvent créer une branche dédié à leur travail.
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 modification sans interférer avec le dépôt principal.
Pour cela, il vous suffit de clique sur le bouton suivant sur la page d’accueil du projet.
Vous serrez alors redirigé vers votre copie du dépôt.
Le dépôt et ses branches
Khanat utilise un workflow simplifié. De ce fait, il y a deux types de branches : principales et temporaires.
Les branches principales sont :
- Branche Master : Branche stable, qui contient toutes les données sonores qui servent au jeu, ainsi que les fichiers source.
- Branche feature/XXX_nom_de_la_feature : Branche contenant des données qui répondront à l'Issue XXX, en cours de travail.
Les branches, que ce soit sur votre fork ou sur les dépôts officiels, doivent être nommées de la façon suivante:
- Branche Feature : Doit être nommée “feature/[numéro(s) de(s) (l')issue][nom de la feature sans espaces ni ponctuation]”
- Exemple : “feature/17_pendo_sounds”
Publication d'une feature
Une fois que vous considérez la feature que vous avez développé terminé, vous pouvez créer une Merge Request, à destination de Master. Cette requête doit respecter ces impératifs :
- La Merge Request doit clairement expliquer la feature (son utilisation, les test à effectuer, etc.)
