Hey beginners,
Felicidades por abrirte camino al código abierto. Es una gran comunidad.
es un poco confuso en el inicio. Cómo contribuir, donde a contribuir, problemas, errores, PR, PR, PR!
no te preocupes, a medida que te involucres en el código abierto lo aprenderás todo.
pero hoy me gustaría darles a todos algunos consejos que nunca recibí cuando comencé mi viaje de código abierto.
empecé a contribuir al código abierto y a poner todos mis pequeños proyectos secundarios en GitHub hace un tiempo., En ese entonces no sabía lo de README. El tiempo pasó y empecé a seguir a algunos desarrolladores kickass. Sin duda todos tenían proyectos increíbles, pero lo más común era que todos sus proyectos tenían un README increíble y así es como llegué a saber sobre la importancia de un buen README.
¡alto!! No estoy interesado en leer sobre su viaje de código abierto. Sólo dime cómo escribir un buen README.
Cool. Así que aquí tienes —
antes de empezar a poner tus proyectos increíbles en GitHub, quiero que vayas y leas primero sobre el desarrollo impulsado por Readme.,
¿Por qué debería importarme un README?
la comunidad de código abierto está creciendo rápidamente. Los desarrolladores lanzan nuevos proyectos de código abierto en GitHub todos los días. Como resultado, cada vez es más difícil lograr que su propio proyecto se destaque del Mar del software de código abierto. Sin embargo, puede hacer algunas cosas para aumentar sus posibilidades de captar la atención de otros desarrolladores. Una técnica eficaz y simple es poner un archivo README bonito y útil.
Su README debe ser tan bueno como su proyecto., Un gran archivo README ayuda a tu proyecto a destacarse del Mar del software de código abierto en GitHub.
un README es como la cara de tu proyecto. Es el primer archivo que una persona debe leer cuando se encuentra con un árbol de fuentes, y debe escribirse como una introducción muy breve y muy básica al software.
un proyecto sin README no es tan útil. Echemos un vistazo a este proyecto, por ejemplo.
no README, no description, no nothing. No tendrás idea de lo que construyó este tipo, no importa lo increíble que sea.,
ahora echemos un vistazo a este proyecto. El autor ha mencionado instrucciones detalladas y claras sobre el proyecto y, por lo tanto, más fáciles de usar y probar para otros.
un buen README es una buena manera de ayudar a las personas a participar en el proyecto también. Un proyecto con un buen README y capturas de pantalla captará mejor la atención de los usuarios, ya que es una forma directa de explicar por qué este proyecto importa, y por qué las personas deben usar y contribuir al proyecto. Un buen README también debe incluir suficientes detalles para ayudar a un nuevo usuario a comenzar, p. ej., cómo compilar, cómo instalar y cómo empezar a integrar.
Ok. Basta de hablar. Muéstrame cómo escribir un buen README entonces.
Ahora que estás de acuerdo en que README importa, Te diré cómo escribir uno. No es tan difícil. Solo tienes que seguir con algunas viñetas. Estos son algunos de los puntos que debe tener en cuenta al escribir un README.
el Formato de archivo LÉAME?,
ahora que te has enseñado a ti mismo cómo y qué escribir en un README, hablemos un poco sobre el estilo de README también conocido como formateo.
el formato es una parte esencial de README. Puedes aprender cómo formatear tu README desde aquí y aquí.
al final, tenga en cuenta-
no necesita ir a un desarrollo completo impulsado por Readme, no necesita incluir todos esos puntos , no necesita seguir ningún proceso en particular. Pero escribir un buen README definitivamente mejorará tus habilidades de documentación, lo que te hará un mejor desarrollador.,
Leave a Reply