valtersit/wordpress-cve-scannerEscanea tu núcleo de WordPress, temas y plugins en busca de CVE conocidos desde la línea de comandos. Código abierto, auditable, centrado en la privacidad — impulsado por la API CVE de ValtersIT.
Para facilitarte el inicio con GitLab, aquí tienes una lista de próximos pasos recomendados.
¿Ya eres un experto? Solo tienes que editar este README.md y hacerlo tuyo. ¿Quieres que sea fácil? Usa la plantilla que está al final.
cd existing_repo
git remote add origin https://gitlab.com/valtersit/wordpress-cve-scanner.git
git branch -M main
git push -uf origin main
Usa la integración continua integrada en GitLab.
Cuando estés listo para hacer tuyo este README, solo tienes que editar este archivo y usar la práctica plantilla que aparece a continuación (o estructurarlo como quieras: ¡esto es solo un punto de partida!). Gracias a makeareadme.com por esta plantilla.
Cada proyecto es diferente, así que considera qué secciones de estas se 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 utilizar 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 tu proyecto específicamente. Proporciona contexto y añade un enlace a cualquier referencia con la que los visitantes puedan no estar familiarizados. También se puede añadir aquí una lista de Características o una subsección de Antecedentes. Si existen alternativas a tu proyecto, este es un buen lugar para enumerar los factores diferenciadores.
En algunos READMEs, puedes ver pequeñas imágenes que transmiten metadatos, como si todas las pruebas del proyecto pasan o no. 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 creando, puede ser buena idea incluir capturas de pantalla o incluso un vídeo (verás con frecuencia GIFs en lugar de vídeos reales). Herramientas como ttygif pueden ayudar, pero echa un vistazo a Asciinema para un método más sofisticado.
Dentro de un ecosistema concreto, 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 quiera más orientación. Enumerar pasos específicos ayuda a eliminar ambigüedades y hace que la gente empiece a usar tu proyecto lo antes posible. Si solo se ejecuta en un contexto específico, como una versión concreta de un lenguaje de programación o un sistema operativo, o tiene dependencias que deben instalarse manualmente, añade también una subsección de Requisitos.
Usa ejemplos con generosidad y muestra la salida esperada si puedes. Es útil tener en línea el ejemplo de uso más pequeño que puedas demostrar, a la vez que proporcionas enlaces a ejemplos más sofisticados si son demasiado largos para incluirlos razonablemente en el README.
Dile a la gente dónde puede acudir para obtener ayuda. Puede ser cualquier combinación de un rastreador de issues, una sala de chat, una dirección de correo electrónico, etc.
Si tienes ideas para futuras versiones, es 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 algo de documentación sobre cómo empezar. Quizá haya un script que deban ejecutar o algunas variables de entorno que deban configurar. Haz explícitos estos pasos. Estas instrucciones también pueden ser útiles para tu yo futuro.
También puedes documentar comandos para lintar 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 una configuración externa, como iniciar un servidor Selenium para probar 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 optar por bifurcar tu proyecto o ofrecerse voluntario para intervenir como mantenedor o propietario, permitiendo que tu proyecto siga adelante. También puedes hacer una solicitud explícita de mantenedores.