From 3546251d9f5fcd21c60fc2eec3719daf8bc14c72 Mon Sep 17 00:00:00 2001 From: Pau Date: Wed, 16 Oct 2024 14:07:18 +0200 Subject: [PATCH] Create styleguide_es.md Spanish translation for the spanish users :) --- docs/styleguide_es.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/styleguide_es.md diff --git a/docs/styleguide_es.md b/docs/styleguide_es.md new file mode 100644 index 00000000000..e226598eb9a --- /dev/null +++ b/docs/styleguide_es.md @@ -0,0 +1,42 @@ +# Guía de Estilo + +Del Manual de Estilo de GitHub, del cual esta guía de estilo hereda: + +> Las palabras son una parte importante de cómo funciona el software. Así como tenemos una guía de estilo para nuestro código, también tenemos una guía de estilo para nuestro tono y nuestra voz. Aunque pueda haber docenas de personas creando un producto, debería sonar como si hablamos con una voz coherente. +> +> En otras palabras, la forma en que escribimos es tan importante como la forma en que diseñamos. Considera estas cosas cuando escribas contenido. + +Cuando sea posible, las [pruebas automatizadas](../test/prose) imponen reglas de estilo. + +## Principios de Contenido +Todo el contenido escrito debe seguir estos principios: + +* **Accesibilidad:** No asumas que el lector tiene conocimientos previos. +* **Brevity:** Manténlo simple, enlaza a contenido externo para profundizar. +* **Curación:** Amplifica las mejores prácticas de la comunidad frente al punto de vista de un individuo. + +El contenido debe mantener un tono ligero pero sabio (piensa en elegante, no en exceso emocionado). ¡El código abierto es divertido! Los lectores deben sentirse inspirados, no desanimados, por el tono de tu escritura, y deben confiar en que les ayudarás a comenzar. + +## Menciones + +Al referirse a personas que usan GitHub, utiliza @menciones de su nombre de usuario en lugar de su nombre completo. + +- :smile: Como dijo @jessfraz... +- :cry: Como dijo [Jess Frazelle](https://github.com/jessfraz)... + +Al referirse a un proyecto en GitHub, enlaza al repositorio para que otros puedan profundizar si lo desean. + +- :smile: @maxogden tomó un enfoque similar a [Dat](https://github.com/datproject/dat)... +- :cry: @maxogden tomó un enfoque similar a Dat... + +## Capitalización + +"Guías" se capitaliza cuando se refiere a las "Guías de Código Abierto", pero no cuando se dice "la guía" o "esta guía". + +- :smile: ¡Bienvenido a las Guías de Código Abierto! +- :smile: La guía está destinada a... +- :cry: El objetivo de esta Guía es... + +## Más orientación + +Entiende nuestro [modelo de contenido](content-model.md) y [audiencia](personas.md).