Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create styleguide_es.md #3317

Closed
wants to merge 1 commit into from
Closed

Create styleguide_es.md #3317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/styleguide_es.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).
Loading