CONTRIBUTING.md

¿Deseas contribuir?

¡Bienvenido! En este documento te mostraremos las guías de contribución de nuestro repositorio para asegurar la calidad del código y el mantenimiento del proyecto 😄

Antes de empezar aquí te recomendamos leer antes el manual de usuario de mdbook ya que este es el motor que usaremos en nuestro "libro".

Archivos .md

Cualquiera puede escribir una página o un capítulo en este repositorio, solo te pedimos que tomes en cuenta los siguientes lineamientos:

• Procura que tus archivos no pasen de la columna 80. (sabemos que no siempre es posible debido a los enlaces u otros medios).
• Se claro y simple al explicar un bloque de código si es que incluyes uno.
• Añade las referencias si es que utilizas alguna, incluso si la licencia del artículo, libro, revista o página web que consultaste permite la reproducción sin mención al autor (Hacer esto en el formato de tu preferencia).
• Mantén una buena ortografía en tus archivos, sabemos que todos cometemos errores, procura mitigar todos los que puedas y no te preocupes si se te escapan uno o dos, la comunidad te ayudará a encontrarlos y mejorar 😉
• Evita el lenguaje altisonante, comúnmente conocido como "Groserías".
• Si vas a corregir un archivo .md de otro usuario procura describir que cambios hiciste y las razones de éstos siempre manteniendo el respeto.

Archivos .rs

Los archivos de Rust que incluyas en el repositorio deberán respetar el estilo de código propuesto en la guía oficial de Rust.

• Sangría de 4 espacios, no tabulaciones, espacios.
• Comentado en caso de necesitar correcciones o interacción con el usuario.