Guía de estilo para Repositorios

Un documento para que tus READMEs se vean chulos.

Descripción

Esta es una guía para que la documentación de nuestros repositorios sea clara, útil y tenga ondita. ✨

Diferencia con la Guía General

La principal diferencia de esta guía con la guía general es cómo tratamos el título principal. Para la portada de un repositorio (un README.rst), queremos que sea amor a primera vista, así que usamos un estilo más simple y directo:

• El título principal solo se subraya con =======. ¡Sin doble línea por encima!

• No usamos un subtítulo formal. En su lugar, ponemos un párrafo corto y coqueto que describa el proyecto.

Este formato es más limpio y minimalista, perfecto para que la gente sepa de qué va tu proyecto al instante. Para todo lo demás (listas, enlaces, tablas, etc.), seguimos las reglas de la guía general.

Recomendaciones

Sub-títulos sugeridos

Aquí tienes una lista de subtítulos que te recomendamos usar en tus READMEs. ¡Son como los ingredientes de una buena receta!

Descripción:

Aquí es donde cuentas de qué va tu increíble proyecto. ¡Échale crema a tus tacos!

Pre-requisitos:

¿Qué se necesita para que tu proyecto funcione? Dilo aquí, sin rodeos.

Procedimiento/Instrucciones:

La guía paso a paso para que la gente pueda usar tu creación. ¡A nadie le gustan los manuales de 300 páginas!

Problemática:

¿Hay problemas conocidos o «workarounds»? Este es el lugar para confesarlos. 😉

Participación:

¿Cómo puede la gente ayudarte a hacer tu proyecto aún más genial?

Contacto:

Deja tus redes sociales, un email, o dónde te pueden encontrar para echar un café (virtual o real).