Ceci est une ancienne révision du document !
Collaborer sur khanat-sound-source
WIP
Le workflow de travail
Avoir un dépôt sur lequel travailler
Mise en place d'un dépôt personnel (fork)
Pour commencer, il vous faudra forker le dépôt principal : khanat-sound-source. 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.
Travailler directement sur le dépôt principal
Si vous êtes un développeur “officiel” chez nous, vous aurez accès au dépôt principal sur notre GitLab : khanat-sound-source.
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 simplifié.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 feature, 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”
Organisation des dossiers et fichiers
Chaque dossier est numéroté en fonction de l'Issue à laquelle il répond, avec un nom descriptif. À l'intérieur de chacun de ces dossiers, il suffit d'avoir un répertoire /_final pour les .wav destinés au système de jeu et un autre /work pour les fichiers qui on servi à les créer. À l'intérieur de ces deux répertoires, on peut organiser comme on veut.
Tant que le travail est en cours, accoler le suffixe _wip à son répertoire principal. Lorsque le travail est terminé, le dernier commit doit ôter ce suffixe.
Les fichiers .wav dans le répertoire /_final doivent impérativement :
- être en .wav
- être en 16-bits PCM
- avoir un nombre pair d'échantillons
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 comment elle répond à la feature
