valtersit/wordpress-cve-scannerAnalizza il core, i temi e i plugin di WordPress alla ricerca di CVE note dalla riga di comando. Open source, verificabile, privacy-first — basato sull'API CVE di ValtersIT.
Per renderti più semplice iniziare con GitLab, ecco un elenco di passaggi successivi consigliati.
Sei già un esperto? Modifica semplicemente questo README.md e rendilo tuo. Vuoi renderlo semplice? Usa il template in fondo!
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 continuous integration integrata in GitLab.
Quando sei pronto a rendere questo README tuo, modifica semplicemente questo file e usa il comodo template qui sotto (oppure strutturailo come preferisci - questo è solo un punto di partenza!). Grazie a makeareadme.com per questo template.
Ogni progetto è diverso, quindi valuta quali di queste sezioni si applicano al tuo. Le sezioni usate nel template sono suggerimenti per la maggior parte dei progetti open source. Tieni anche presente che, sebbene un README possa essere troppo lungo e dettagliato, troppo lungo è meglio che troppo corto. Se pensi che il tuo README sia troppo lungo, valuta di utilizzare un'altra forma di documentazione invece di tagliare informazioni.
Scegli un nome autoesplicativo per il tuo progetto.
Fai sapere alle persone cosa può fare concretamente il tuo progetto. Fornisci contesto e aggiungi un link a qualsiasi riferimento con cui i visitatori potrebbero non avere familiarità. Qui puoi anche aggiungere un elenco di Funzionalità o una sottosezione Contesto. Se esistono alternative al tuo progetto, questo è un buon posto per elencare i fattori che lo distinguono.
In alcuni README, potresti vedere piccole immagini che trasmettono metadati, come ad esempio se tutti i test del progetto stanno passando o meno. Puoi usare Shields per aggiungerne alcuni al tuo README. Molti servizi hanno anche istruzioni per aggiungere un badge.
A seconda di ciò che stai realizzando, può essere una buona idea includere screenshot o persino un video (vedrai spesso GIF anziché video veri). Strumenti come ttygif possono aiutare, ma dai un'occhiata ad Asciinema per un metodo più sofisticato.
All'interno di un particolare ecosistema, potrebbe esserci un modo comune di installare le cose, come usare Yarn, NuGet o Homebrew. Tuttavia, considera la possibilità che chiunque legga il tuo README sia un principiante e desideri maggiori indicazioni. Elencare passaggi specifici aiuta a rimuovere ambiguità e porta le persone a usare il tuo progetto il prima possibile. Se funziona solo in un contesto specifico, come una particolare versione di un linguaggio di programmazione o sistema operativo, o ha dipendenze che devono essere installate manualmente, aggiungi anche una sottosezione Requisiti.
Usa gli esempi abbondantemente e mostra l'output previsto se puoi. È utile avere inline il più piccolo esempio di utilizzo che puoi dimostrare, fornendo al contempo link a esempi più sofisticati se sono troppo lunghi per essere ragionevolmente inclusi nel README.
Di' alle persone dove possono andare per ricevere aiuto. Può essere qualsiasi combinazione di un issue tracker, una chat room, un indirizzo email, ecc.
Se hai idee per rilasci futuri, è una buona idea elencarle nel README.
Dichiara se sei aperto ai contributi e quali sono i tuoi requisiti per accettarli.
Per le persone che vogliono apportare modifiche al tuo progetto, è utile avere un po' di documentazione su come iniziare. Forse c'è uno script che dovrebbero eseguire o alcune variabili d'ambiente che devono impostare. Rendi espliciti questi passaggi. Queste istruzioni potrebbero essere utili anche al tuo te stesso futuro.
Puoi anche documentare i comandi per il linting del codice o per eseguire i test. Questi passaggi aiutano a garantire un'elevata qualità del codice e riducono la probabilità che le modifiche rompano qualcosa inavvertitamente. Avere istruzioni per eseguire i test è particolarmente utile se richiede una configurazione esterna, come avviare un server Selenium per i test in un browser.
Mostra il tuo apprezzamento a coloro che hanno contribuito al progetto.
Per i progetti open source, indica come è concesso in licenza.
Se hai esaurito le energie o il tempo per il tuo progetto, aggiungi una nota in cima al README dicendo che lo sviluppo è rallentato o si è fermato completamente. Qualcuno potrebbe scegliere di fare un fork del tuo progetto o offrirsi volontario come maintainer o owner, permettendo al tuo progetto di continuare. Puoi anche fare una richiesta esplicita di maintainer.