Différences

Ci-dessous, les différences entre deux révisions de la page.

--- fr:collabo_khanat-sound-source [2016/11/14 22:22] – créée YannK
+++ fr:collabo_khanat-sound-source [2021/12/03 19:19] (Version actuelle) – modification externe 127.0.0.1
@@ Ligne 1: / Ligne 1: @@
 ====== Collaborer sur khanat-sound-source ======
-<WRAP center round important 60%>
+{{ :fr:sound.png?direct&200 |}}
-WIP
-</WRAP>
-===== Le workflow de travail =====
+Ce dépôt concerne la création des éléments sonores qui serviront en jeu. Nous y concevons donc tous les fichiers qui seront ensuite passés au pipeline pour fournir les éléments nécessaires au système de jeu selon ses spécifications.
-==== Mise en place d'un dépôt personnel (fork) ====
+Nous y conservons les versions finales des fichiers qui ont servi à créer le résultat, dans le format nécessaire au pipeline. Mais nous y stockons également les versions préparatoires de façon à en faciliter l'éventuelle déclinaison ou transformation à l'avenir.
-<WRAP center round important 90%>
+N'hésitez donc pas à y déposer les dossiers Ardour, les banques de son etc. qui pourraient être réutilisées par la suite.
-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.
+===== Le workflow de travail =====
+<WRAP center round info 90%>
+Créez toujours une [[#gestion_des_issues|Issue]] avant de commencer une tâche qui n'y est pas référencée.
+\\ Cela permet de suivre le travail en vérifiant si une branche Git avec ce numéro existe, de façon à éviter de refaire du travail déjà commencé.
 </WRAP>
-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.
+==== 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 : [[gitlab>khaganat/khanat-sound-source|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.
@@ Ligne 21: / Ligne 27: @@
 Vous serrez alors redirigé vers votre copie du dépôt.
-==== Le dépôt et ses branches ====
+=== Travailler directement sur le dépôt principal ===
-Khanat utilise un workflow simplifié. De ce fait, il y a deux types de branches : principales et temporaires.
+Si vous êtes un développeur "officiel" chez nous, vous aurez accès au dépôt principal sur notre GitLab : [[gitlab>khaganat/khanat-sound-source|khanat-sound-source]].
-Les branches principales sont :
+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.
@@ Ligne 31: / Ligne 41: @@
   * 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:
+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 ====
@@ Ligne 40: / Ligne 62: @@
 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.)
+  * La Merge Request doit clairement expliquer comment elle répond à la feature
 ===== 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 [[taf>fr:start|la base TAF]], créez les demandes de travaux sonores sur le système Gitlab de ce dépôt.
+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.
+Cela peut concerner des créations sonores pour l'interface, de la musique, des bruits d'objets, d'environnement ou pour une créature.
+Les travaux à faire, modifications de fichier, créations, doivent être indiqués en se servant du système d'//Issues// de ce dépôt : [[gitlab>khaganat/khanat-sound-source/issues|Issue sur Khanat-sound-source]]
+Il suffit de cliquer sur : {{ :fr:new_issue2.jpg?nolink |}}
+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 :
+  * //Assignee// pour indiquer la personne à qui affecter la tâche ;
+  * //Milestone// qui désigne la version du projet pour laquelle ce travail devra être fait ;
+  * //Labels// permet de choisir des tags pour déterminer le genre de tâche ;
+  * //Select due date// propose de fixer une date de remise des travaux.
+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 [[fr: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 concerner de préférence un type technique de son (environnement, créature, musique...) 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.
 {{tag>Données Ryzom_Core Outils Son}}