Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente | ||
fr:godot:collaborer [2021/09/27 21:36] – [Le dépôt et ses branches] YannK | fr:godot:collaborer [2023/07/26 19:50] (Version actuelle) – YannK | ||
---|---|---|---|
Ligne 2: | Ligne 2: | ||
{{ : | {{ : | ||
+ | |||
+ | Ce dépôt [[https:// | ||
+ | |||
+ | <WRAP center round important 60%> | ||
+ | La mise en place des submodules est en cours, mais non encore mise en place. Si la question vous intéresse, on en parle dans [[https:// | ||
+ | </ | ||
+ | |||
+ | ===== Chronologie ===== | ||
+ | |||
+ | Nous n' | ||
+ | |||
+ | Chaque version est numérotée x.y.z (voir la [[https:// | ||
+ | * x = version majeure. On le change quand les changements ne sont pas rétrocompatibles | ||
+ | * y = version mineure. L’incrémentation se fait lorsqu’un ensemble de nouvelles fonctionnalités défini a été intégré, la compatibilité doit être maintenue, sauf dans le cas où la version majeure est en 0, car de nombreux changements peuvent être nécessaires avant de passer à la version 1.0. | ||
+ | * z = version corrective. Incrémentée lorsque des correctifs de bugs sont ajoutés à une version mineure, sans ajout de nouvelle fonctionnalité. | ||
+ | |||
+ | ===== Versions ===== | ||
+ | |||
+ | ==== Version 0.1 ==== | ||
+ | |||
+ | Le but de la 0.1 est d’avoir un client local qui permette de déplacer le personnage dans un environnement minimaliste extérieur statique, avec un résultat visuel sobre mais attrayant, présentant des spécificités du monde du Khanat et simple techniquement afin de tester les outils et processus de collaboration. | ||
+ | |||
+ | Ce sera l’occasion | ||
+ | |||
+ | Aucune fonctionnalité via un serveur n’aura à être implémentée. | ||
+ | |||
+ | Lien vers le suivi des Tickets/ | ||
===== Le workflow de travail ===== | ===== Le workflow de travail ===== | ||
+ | |||
<WRAP center round info 90%> | <WRAP center round info 90%> | ||
Créez toujours [[# | Créez toujours [[# | ||
Ligne 30: | Ligne 58: | ||
<WRAP center round important 60%> | <WRAP center round important 60%> | ||
- | Modification des process | + | Si vous n’avez pas accès |
</ | </ | ||
Ligne 36: | Ligne 64: | ||
Khanat utilise un workflow simplifié. Les branches principales sont : | Khanat utilise un workflow simplifié. Les branches principales sont : | ||
- | * Branche **Master** : Branche **stable**, | + | * Branche **stable** : c’est la branche |
- | * Branche **module/ | + | * Branche **XXX_titre_du_ticket** : Branche contenant le développement d’un |
- | * Branche **Develop** : Branche | + | * Branche **develop** : Branche |
- | Les branches | + | Les branches |
- | * Branche **Module** : Doit être nommée "module/[numéro_du_module][nom du module sans espaces ni ponctuation]" | + | * Branche **Module** : Doit être nommée "[numéro_du_ticket]_[titre du ticket |
- | * Exemple : " | + | * Exemple : pour travailler sur le ticket numéro 2 titré « Faire une des tâches détaillée de la tâche globale XXX », il faut créer une branche « 2-faire-une-des-taches-detaillee-de-la-tache-globale-xxx » |
- | ==== Publication d'un module ==== | + | Si vous êtes développeur officiel chez nous, vous pourrez créer automatiquement la branche et la merge request depuis l’issue en cliquant sur le bouton prévu : |
- | Une fois que vous considérez le module que vous avez développé terminé, vous pouvez créer une Merge Request, à destination de **Master**. Cette requête doit respecter ces impératifs | + | {{ :fr: |
- | * La Merge Request doit clairement expliquer comment elle répond à la feature | ||
+ | ==== Travail sur un ticket ==== | ||
+ | |||
+ | Si vous travaillez depuis un fork, vous devez créer une Merge Request, à destination de **develop** sur notre dépôt. Cette requête doit respecter ces impératifs : | ||
+ | |||
+ | * elle doit avoir comme titre « Draft: Resolve "titre du ticket" | ||
+ | * elle doit comporter en première ligne de sa description une commande pour fermer le ticket correspondant. Dans notre cas, ce serait « Closes #2 ». | ||
+ | |||
+ | ==== Merge sur la branche « stable » ==== | ||
+ | |||
+ | Une fois que l’ensemble des Tickets/ | ||
+ | |||
+ | Il est indispensable de bien vérifier le changelog à ce moment là, selon le modèle de [keepachangelog.com](https:// | ||
+ | |||
+ | Lors du commit de merge, il faudra passer une commande pour que la CI de Gitlab compile les clients ([[https:// | ||
===== Gestion des Merge Request ===== | ===== Gestion des Merge Request ===== | ||
- | Lorsqu' | + | Il ne faut pas hésiter à laisser des commentaires sur la demande de Merge Request, cette page est là pour expliquer les soucis, détailler |
- | Cela permettra d' | + | Lors de la validation de la Merge Request, on efface la branche de travail et on ne squashe pas les commits. |
- | **On ne merge jamais soi-même directement | + | **Dans la mesure du possible, on ne merge jamais soi-même directement**. |
- | ===== Gestion des Issues ===== | + | ===== Gestion des Tickets / Issues ===== |
- | Créez les demandes de fonctionnaltiés | + | Créez les demandes de fonctionnalités |
<WRAP center round info 80%> | <WRAP center round info 80%> | ||
- | Avant de commencer une tâche, créez une Issue que vous vous attribuez, comme ça on sait que quelqu' | + | Avant de commencer une tâche |
</ | </ | ||
Ligne 79: | Ligne 120: | ||
\\ Par contre, n' | \\ Par contre, n' | ||
- | Il y a ensuite | + | Il y a ensuite |
- | * // | ||
* // | * // | ||
* //Labels// permet de choisir des tags pour déterminer le genre de tâche (voir [[# | * //Labels// permet de choisir des tags pour déterminer le genre de tâche (voir [[# | ||
- | * //Select due date// propose de fixer une date de remise des travaux. | ||
- | Dans le doute, n' | + | Dans le doute, n' |
+ | |||
+ | ===== Gestion des messages dans les Tickets / Issues ===== | ||
+ | |||
+ | Pour chaque ticket, il est possible de laisser des messages. Chacun d’eux initie un fil de discussion auquel on peut répondre en cliquant sur l’icône de bulle dans son coin supérieur droit. Cela permet de conserver des fils thématiques sur des sujets abordés par le ticket. | ||
+ | |||
+ | {{ : | ||
===== Gestion des dossiers et des fichiers ===== | ===== Gestion des dossiers et des fichiers ===== | ||
+ | |||
+ | Les noms des dossiers et des fichiers sont écrits en [[https:// | ||
**Les commentaires dans le code/les scripts se font en anglais**, de façon à ce que le code soit international. | **Les commentaires dans le code/les scripts se font en anglais**, de façon à ce que le code soit international. | ||
Ligne 117: | Ligne 164: | ||
Description : | Description : | ||
* contributors : | * contributors : | ||
- | * indiquer le nom (obligatoire), | + | * indiquer le nom/le pseudonyme |
* licence : | * licence : | ||
* indiquer la licence appliquée aux fichiers de ce répertoire, | * indiquer la licence appliquée aux fichiers de ce répertoire, | ||
Ligne 129: | Ligne 176: | ||
===== Gestion des Commits ===== | ===== Gestion des Commits ===== | ||
- | **On rédige ses commits en anglais**, de façon à ce que le code soit international (même si c’est du franglais, aucune importance). | + | **On rédige ses commits en anglais**, de façon à ce que le code soit international (même si c’est du franglais, aucune importance). Ne pas hésiter à remettre dans chaque message de Commit le numéro de ticket correspondant, |
- | Un commit est impérativement nommé en référence à un '' | ||
===== Gestion des Milestones ===== | ===== Gestion des Milestones ===== | ||
- | On se servira des // | + | On se servira des // |
===== Gestion des Tags ===== | ===== Gestion des Tags ===== | ||
Nous n' | Nous n' | ||
- | |||
- | <WRAP center round todo 60%> | ||
- | Étudier la question et voir comment les déployer sur le projet | ||
- | </ | ||
===== Gestion des Labels ===== | ===== Gestion des Labels ===== | ||
- | Nous n’utilisons pour l’instant que deux '' | + | La liste des Labels/ |
- | * '' | + | |
- | * '' | + | |
- | {{tag> | + | {{tag> |