Lignes directrices pour le triage des bogues

Cette page décrit le flux de travail typique de l’équipe de triage des bogues alias bugsquad lors de la gestion des problèmes et des requêtes pull sur le dépôt GitHub de Godot. Elle est appelée à évoluer avec le bugsquad, n’hésitez donc pas à proposer des modifications aux directives suivantes.

Gestion des Issues

GitHub propose différentes fonctionnalités pour gérer les issues :

  • Définir un ou plusieurs labels à partir d’une liste prédéfinie
  • Poser un « milestone » à partir d’une liste prédéfinie
  • Suivez l’évolution de l’issue dans le tableau de bord du projet
  • Définir un contributeur comme « assignee » parmi les membres de l’organisation du moteur Godot

Comme l’organisation du moteur Godot sur GitHub a actuellement un nombre restreint de contributeurs, nous n’utilisons pas beaucoup de cessionnaires pour l’instant. Tous les contributeurs sont les bienvenus pour prendre en charge tout problème, le cas échéant après l’avoir mentionné sur le ticket de problème et/ou avoir discuté de la meilleure façon de le résoudre avec d’autres développeurs.

Pour l’instant, nous n’utilisons pas non plus la fonction de tableau de bord du projet.

Dans la mesure du possible, nous essayons d’attribuer des étiquettes (et des « milestones » le cas échéant) aux deux questions et aux demandes de retrait.

Labels

Les labels suivants sont actuellement définis dans le dépôt Godot :

Catégories :

  • Archivé : soit un double d’un autre numéro, soit non valable. Une telle issue serait également fermé.
  • Bug : décrit quelque chose qui ne fonctionne pas correctement.
  • Confirmed : a été confirmée par au moins un autre contributeur que le rapporteur de bogue (généralement pour les rapports de bogue). L’objectif de ce label est de faire savoir aux développeurs quels problèmes sont encore reproductibles lorsqu’ils veulent choisir sur quoi travailler. C’est donc une bonne pratique que d’ajouter un commentaire sur la plate-forme et la version ou le commit de Godot sur lesquels le problème pourrait être reproduit ; si un développeur examine le problème un an plus tard, le label Confirmed peut ne plus être pertinent.
  • Discussion : la question n’est pas consensuelle et nécessite une discussion plus approfondie afin de définir ce qui doit être fait exactement pour traiter le sujet.
  • Documentation : question liée à la documentation. Principalement pour demander des améliorations dans la documentation de l’API. Les problèmes liés à la documentation de ReadTheDocs doivent être classés dans le dépôt godot-docs.
  • Enhancement : décrit une proposition d’amélioration d’une fonctionnalité existante.
  • Feature proposal : décrit un souhait de mise en œuvre d’une nouvelle fonctionnalité.
  • Junior job : le problème est présumé être facile à résoudre, ce qui en fait un outil idéal pour les jeunes contributeurs qui doivent se familiariser avec la base de code.
  • Needs rebase : l’issue nécessite un Git rebase pour être fusionnée.
  • Needs testing : l’issue ou la Pull Request n’a pas pu être complètement testée et doit donc être soumise à des tests supplémentaires. Cela peut signifier qu’elle doit être testée sur différentes configurations matérielles/logicielles ou même que les étapes à reproduire ne sont pas certaines.
  • PR welcome / hero wanted ! : Les contributions pour les questions relatives à ces labels sont particulièrement bienvenues. Notez que cela ne signifie pas que vous ne pouvez pas travailler sur des sujets sans ces labels.
  • Tracker : issue utilisé pour suivre d’autres problèmes (comme tous les problèmes liés au système de plugin).
  • Usability : Issues qui ont un impact direct sur l’intuitivité du moteur pour les utilisateurs.

Les catégories sont utilisées pour le triage des issues. Ils peuvent être combinés, d’une certaine façon, lorsque cela est pertinent, par exemple, un problème peut être étiqueté Enhancement et Usability en même temps, si c’est une issue pour améliorer la facilité d’utilisation. Ou Feature Proposal et de Discussion si c’est une demande de fonctionnalités dont l’implémentation doit être discutée, ou une qui n’est pas assez précise pour être implémenté.

Topics :

  • Assetlib : concerne les questions relatives à la bibliothèque d’asset.
  • Audio : concerne les fonctions audio (haut et bas niveau).
  • Buildsystem : concerne les problèmes de compilation, soit liés au système de compilation SCons, soit aux particularités du compilateur.
  • Core : tout ce qui est lié au cœur du moteur. Il pourrait être divisé en plusieurs labels plus tard, car c’est un sujet assez vaste.
  • Drivers : concerne les problèmes liés aux logiciels pilotes utilisés par le moteur.
  • Editor : concerne les issues de l’éditeur (principalement l’interface utilisateur).
  • GDNative : concerne le module GDNative.
  • GDScript : se rapporte au GDScript.
  • Mono : concerne les liaisons C# / Mono.
  • Network : se rapporte aux problème de mise en réseau.
  • Physics : concerne le moteur physique (2D/3D).
  • Plugin : concerne les problèmes rencontrés lors de l’écriture de plugins.
  • Porting : concerne certaines plateformes spécifiques.
  • Rendering : concerne les moteurs de rendu 2D et 3D.
  • VisualScript : concerne les problèmes liés au langage de script visuel.

Les Issues ne correspondent généralement qu’à un seul sujet, bien qu’il ne soit pas impensable d’en voir qui puissent concerner deux sujets. L’idée est qu’il y aura des équipes de contributeurs spécialisés derrière tous les sujets, afin qu’ils puissent se concentrer sur les questions étiquetées avec le sujet de leur équipe.

Platforms :

Android, HTML5, iOS, Linux, macOS, Windows, UWP

Par défaut, on suppose qu’une issue donnée s’applique à toutes les plateformes. Si l’une des étiquettes de plate-forme est utilisée, elle est alors exclusive et l’hypothèse précédente ne tient plus (donc si c’est un bug sur par exemple Android et Linux exclusivement, sélectionnez ces deux plates-formes).

Étapes

Les Milestones (Jalon) correspondent aux futures versions de Godot prévues pour lesquelles il existe une feuille de route. Les questions qui s’inscrivent dans ladite feuille de route doivent être classées dans la milestone correspondante ; si elles ne correspondent à aucune feuille de route actuelle, elles doivent être laissées hors de toute milestone. En règle générale, un problème correspond à une milestone donnée s’il concerne une nouvelle fonctionnalité de la milestone, ou un bogue critique qui ne peut être accepté dans une future version stable, ou tout ce sur quoi Juan veut travailler maintenant :)

Les contributeurs sont libres de choisir les problèmes indépendamment du jalon qui leur est attribué ; si une correction est proposée pour un bogue qui n’a pas été jugé urgent et donc sans milestone, elle sera probablement toujours la bienvenue.