cryptoadvocate/dcsgonefwbspEl hogar del paquete de soporte de placa de firmware del primer proyecto de insignia electrónica de Circuit Crafters.
Para facilitarte el inicio con GitLab, aquí tienes una lista de pasos recomendados a seguir.
¿Ya eres un profesional? Simplemente edita este README.md y hazlo tuyo. ¿Quieres hacerlo fácil? Usa la plantilla al final!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Usa la integración continua integrada en GitLab.
Cuando estés listo para hacer este README tuyo, simplemente edita este archivo y usa la práctica plantilla de abajo (o siéntete libre de estructurarlo como quieras – ¡esto es solo un punto de partida!). Gracias a makeareadme.com por esta plantilla.
Cada proyecto es diferente, así que considera cuáles de estas secciones aplican al tuyo. Las secciones usadas en la plantilla son sugerencias para la mayoría de los proyectos de código abierto. También ten en cuenta que, aunque un README puede ser demasiado largo y detallado, demasiado largo es mejor que demasiado corto. Si crees que tu README es demasiado largo, considera usar otra forma de documentación en lugar de recortar información.
Elige un nombre autoexplicativo para tu proyecto.
Haz saber a la gente qué puede hacer específicamente tu proyecto. Proporciona contexto y añade un enlace a cualquier referencia que los visitantes puedan no conocer. También se puede añadir aquí una lista de Funcionalidades o una subsección de Antecedentes. Si hay alternativas a tu proyecto, este es un buen lugar para enumerar los factores diferenciadores.
En algunos README, puedes ver pequeñas imágenes que transmiten metadatos, como si todas las pruebas están pasando para el proyecto. Puedes usar Shields para añadir algunas a tu README. Muchos servicios también tienen instrucciones para añadir una insignia.
Dependiendo de lo que estés haciendo, puede ser una buena idea incluir capturas de pantalla o incluso un video (a menudo verás GIFs en lugar de videos reales). Herramientas como ttygif pueden ayudar, pero echa un vistazo a Asciinema para un método más sofisticado.
Dentro de un ecosistema particular, puede haber una forma común de instalar cosas, como usar Yarn, NuGet o Homebrew. Sin embargo, considera la posibilidad de que quien lea tu README sea un principiante y necesite más orientación. Enumerar pasos específicos ayuda a eliminar ambigüedades y hace que la gente use tu proyecto lo más rápido posible. Si solo funciona en un contexto específico, como una versión particular de lenguaje de programación o sistema operativo, o tiene dependencias que deben instalarse manualmente, añade también una subsección de Requisitos.
Usa ejemplos generosamente y muestra el resultado esperado si puedes. Es útil incluir en línea el ejemplo más pequeño de uso que puedas demostrar, mientras proporcionas enlaces a ejemplos más sofisticados si son demasiado largos para incluirlos razonablemente en el README.
Dile a la gente a dónde pueden acudir para obtener ayuda. Puede ser cualquier combinación de un rastreador de incidencias, una sala de chat, una dirección de correo electrónico, etc.
Si tienes ideas para futuros lanzamientos, es una buena idea enumerarlas en el README.
Indica si estás abierto a contribuciones y cuáles son tus requisitos para aceptarlas.
Para las personas que quieran hacer cambios en tu proyecto, es útil tener alguna documentación sobre cómo empezar. Quizás hay un script que deberían ejecutar o algunas variables de entorno que deben configurar. Haz explícitos estos pasos. Estas instrucciones también pueden ser útiles para tu yo futuro.
También puedes documentar comandos para verificar el código o ejecutar pruebas. Estos pasos ayudan a garantizar una alta calidad del código y reducen la probabilidad de que los cambios rompan algo inadvertidamente. Tener instrucciones para ejecutar pruebas es especialmente útil si requiere configuración externa, como iniciar un servidor Selenium para pruebas en un navegador.
Muestra tu agradecimiento a quienes han contribuido al proyecto.
Para proyectos de código abierto, indica cómo está licenciado.
Si te has quedado sin energía o tiempo para tu proyecto, pon una nota al principio del README diciendo que el desarrollo se ha ralentizado o se ha detenido por completo. Alguien puede bifurcar tu proyecto u ofrecerse como mantenedor o propietario, permitiendo que tu proyecto continúe. También puedes hacer una solicitud explícita de mantenedores.