Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Guía de estilo del editor

Introducción

¡Gracias por tú interes en contribuir al editor de Godot!

Está página describe los estilos de gramática y escritura usados a lo largo del editor de Godot. Seguir esta guía de estilos ayudará a que tú contribución se fusione (merge) más rapido ya que se necesitarán menos pasos para su revisión.

Estilo de escritura

  • Escribe mensajes (errores, advertencias, ...) como frases completas. Las frases deberían empezar con letra mayúscula y acabar con un punto.

  • Intenta mantener las frases cortas. Esto aumenta la probabilidad de que sus traducciones también sean cortas, lo cual es beneficioso para evitar errores en la interfaz de usuario.

  • Usa contracciones. Por ejemplo, usa "isn't" en lugar de "is not". Se puede hacer una excepción a esta regla cuando específicamente deseas enfatizar una de las palabras de la contracción.

  • Usa comillas dobles en los mensajes ("") en vez de comillas simples (''). Las comillas dobles deberían usarse para citar la entrada de usuario, rutas de archivos y posiblemente otras cosas dependiendo del contexto.

Ver también

De manera adicional a las guías resaltadas arriba intenta seguir Writing guidelines.

Textos en menus y botones

Capitalizar el texto de los botones y los menús de acción:

  • Bien: Open Editor Data Folder

  • Mal: Open editor data folder

Si un menú de acción abre un dialogo modal, añade el sufijo de elipsis (...).

  • Bien: Editor Settings...

  • Mal: Editor Settings

Secciones del inspector

En general, evita crear secciones que contengan menos de 3 elementos. Las secciones con pocos elementos dificultan la navegación en el inspector y se pierden los beneficios de utilizar secciones, como el plegado.

There are some valid exceptions for this, such as material features in StandardMaterial3D.

Este consejo también se aplica a la Configuración del Proyecto y Configuración del Editor.

Hints de rendimiento del inspector

Las propiedades de tipo enumerado que tienen un impacto notable en el rendimiento deben tener una indicación de rendimiento asociada. La indicación debe referirse al impacto de rendimiento absoluto, en lugar de ser relativo a las otras opciones proporcionadas en el enumerado. Aquí tienes algunos ejemplos tomados del editor de Godot:

  • Antialiasing de espacio de pantalla: Desactivado (Más rápido), FXAA (Rápido)

  • Calidad de MSAA: Desactivado (Más rápido), 2x (Rápido), 4x (Promedio), 8x (Lento), 16x (Más lento)

  • Modo de luz direccional: Ortogonal (Rápido), PSSM 2 divisiones (Promedio), PSSM 4 divisiones (Lento)

Para mantener la consistencia, trata de usar los siguientes términos (de más rápido a más lento):

  • Fastest, Más rápido, Rápido, Promedio, Lento, Más lento, Más lento aún

Su uso no tiene que ser contiguo. Por ejemplo, puedes utilizar solo "Fast" (Rápido) y "Slow" (Lento) de la lista anterior.

Si estás agregando un nuevo enumerador, sus valores deben estar ordenados de la opción más rápida a la opción más lenta.

Descripciones emergentes

Considera agregar información emergente (tooltips) cuando la acción realizada por un botón o una acción de menú no es obvia. También puedes proporcionar contexto adicional o resaltar advertencias en el tooltip.

Puedes hacer esto llamando a set_tooltip(TTR("Texto aquí.")) en el nodo basado en Control correspondiente. Si el tooltip es particularmente largo (más de ~80 caracteres), divídelo en varias líneas agregando saltos de línea usando \n.

Las descripciones deben seguir el estilo de escritura descrito anteriormente. Además de esto, usa el modo indicativo en lugar del modo imperativo:

  • Correcto: Calcula la iluminación global para el GIProbe seleccionado.

  • Incorrecto: Calcular la iluminación global para el GIProbe seleccionado.