Guide de style de l'éditeur

Introduction

Merci de votre intérêt à la contribution à l'éditeur de Godot !

Cette page décrit la grammaire et le style d'écriture utilisés dans l'éditeur Godot. Suivre ce guide de style, aidera votre contribution a être fusionnée plus rapidement, car les étapes de révision seront moins nombreuses.

Style d'écriture

  • Écrivez les messages (erreurs, avertissements, ...) sous forme de phrases complètes Elles doivent commencer par une lettre majuscule et se terminer par un point.
  • Essayez de garder les phrases courtes. Cela rend plus probable que leurs traductions soient également courtes, ce qui est une bonne chose pour éviter les bogues de l'interface utilisateur.
  • Utilisez des contractions. Par exemple, utilisez "isn't" au lieu de "is not". Une exception à cette règle peut être faite lorsque vous souhaitez spécifiquement souligner l'un des mots de la contraction.
  • Utilisez des guillemets doubles dans les messages ("") au lieu de guillemets simples (''). Les guillemets doubles doivent être utilisés pour citer les entrées de l'utilisateur, les chemins d'accès aux fichiers et éventuellement d'autres choses selon le contexte.

Voir aussi

Essayez de suivre les lignes directrices Directives pour la rédaction de documentation en plus des lignes directrices décrites ci-dessus.

Textes des boutons et des menus

Mettez le texte en majuscule dans les boutons et les actions de menu :

  • Bien : Open Editor Data Folder
  • Mauvais : Open editor data folder

Si une action de menu ouvre un dialogue modal, suffixez-le par une ellipse (...).

  • Bon : Editor Settings...
  • Mauvais : Editor Settings

Sections de l'inspecteur

En général, ne créez pas de sections qui contiennent moins de 3 éléments. Les sections qui contiennent peu d'éléments rendent la navigation dans l'inspecteur difficile, tout en ne bénéficiant pas des avantages de l'utilisation de sections telles que le pliage.

Il y a quelques exceptions valables, telles que les caractéristiques matérielles dans SpatialMaterial.

Ces conseils s'appliquent également aux paramètres du projet et de l'éditeur.

Indices de performance de l'inspecteur

Les propriétés énumérées qui ont un impact notable sur les performances devrait être associé à un indice de performance. L'indice doit faire référence à l'impact absolu sur les performances, plutôt que d'être relatif aux autres options fournies dans l'énumération. Voici quelques exemples tirés de l'éditeur Godot :

  • Screen-space antialiasing: Disabled (Fastest), FXAA (Fast)
  • MSAA quality: Disabled (Fastest), 2x (Fast), 4x (Average), 8x (Slow), 16x (Slower)
  • DirectionalLight mode: Orthogonal (Fast), PSSM 2 Splits (Average), PSSM 4 Splits (Slow)

Par souci de cohérence, essayez de vous en tenir aux termes ci-dessous (de fastest à slowest) :

  • Fastest, Faster, Fast, Average, Slow, Slower, Slowest

Leur utilisation n'a pas besoin d'être contiguë. Par exemple, vous pouvez utiliser uniquement "Fast" et "Slow" dans la liste ci-dessus.

Si vous ajoutez une nouvelle énumération, ses valeurs doivent être classées de l'option la plus rapide à l'option la plus lente.

Info-bulles

Envisagez d'ajouter des infobulles chaque fois que l'action effectuée par un bouton ou une action de menu n'est pas évidente. Vous pouvez également fournir un contexte supplémentaire ou mettre en évidence des avertissements dans l'infobulle.

Vous pouvez le faire en appelant set_tooltip(TTR("Text here.")) sur le noeud basé sur Control en question. Si l'info-bulle est particulièrement longue (plus de ~80 caractères), vous pouvez l'encapsuler sur plusieurs lignes en ajoutant des sauts de ligne en utilisant \n.

Les infobulles doivent suivre le style d'écriture décrit ci-dessus. En outre, utilisez un ton indicatif au lieu d'un ton impératif :

  • Bon : Computes global illumination for the selected GIProbe.
  • Mauvais : Compute global illumination for the selected GIProbe.