Cargando…

Esto está tardando más de lo esperado.

Estándares de código

Documentation

Estos son los estándares que aplica el analizador. Cada regla dice qué revisa y por qué existe.

Todos los estándares

La documentación se escribe en inglés

Todos los archivos Markdown del repositorio se escriben en inglés. Un repositorio tiene un idioma de trabajo, y la documentación que se desvía a otro divide a sus lectores: la siguiente persona que abra el archivo puede no ser quien lo escribió.
Esto cubre el README.md raíz, la documentación del proyecto en docs/, las guías, los estándares y cualquier archivo de instrucciones que lea un asistente.
Hay dos casos que no lo incumplen.
Un archivo dentro de una carpeta de locale está escrito en el idioma de ese locale. Un segmento de ruta que nombra un idioma — es, en, pt — declara qué contiene el archivo, y un documento en español dentro de es/ está cumpliendo exactamente su función. El inglés sigue siendo la fuente.

handbook/onboarding.md              English, the source
handbook/es/onboarding.md           Spanish, translated from it

Un documento escrito para el cliente se redacta en el idioma del cliente. Un análisis de funcionalidades dentro de una carpeta analysis/ es un entregable que alguien ajeno al equipo lee y aprueba, así que sigue a ese lector, no al repositorio. Lo mismo aplica a cualquier documento generado que se entregue a un usuario.
Todo lo demás usa inglés por defecto, incluido un archivo que solo el equipo vaya a leer. "Solo yo voy a leer esto" es como un repositorio termina en dos idiomas.
El validador revisa cada bloque de prosa Markdown de forma independiente. Fuera de las excepciones anteriores, un bloque que contenga más de tres palabras distintas en español se considera prosa en español y es una infracción, incluso si el resto del documento está en inglés. Los bloques de código y el código en línea son ejemplos, no prosa de documentación, así que quedan excluidos.
Cuando un documento tenga que cambiar de idioma, muévelo y tradúcelo en cambios separados. Un diff que reubica y reescribe a la vez no se puede comprobar: un párrafo perdido en el movimiento se ve exactamente igual que un párrafo reformulado en la traducción.

Una traducción dice lo que dice su original

Un documento traducido y su original son un mismo documento en dos idiomas, no dos documentos. Corregir la redacción de una traducción es bienvenido: una frase torpe, un término que nadie usa, una formulación que suena a traducción en lugar de a texto escrito originalmente así. Cambiar lo que afirma no lo es.
Añadir un paso que no está en el texto en inglés, omitir una advertencia, suavizar una limitación o actualizar una página traducida dejando atrás su original produce dos documentos que no coinciden, y quien los lea no tiene forma de saber cuál es el verdadero.
Cuando el contenido en sí tenga que cambiar, cambia el inglés y vuelve a traducirlo. El original va primero, siempre.

Correct    — the English says the code arrives by SMS or by call;
             the Spanish is reworded so it reads naturally, saying the same thing
Incorrect  — the English says by SMS or by call;
             the Spanish adds "or by WhatsApp" because it happens to be true

Los documentos de ayuda llevan una huella del inglés a partir del que se escribieron, para que php artisan help:stamp --check pueda informar de una traducción cuyo original ha cambiado.

Weblabor Logo Desarrollado por Weblabor