valtersit/wordpress-cve-scannerAnalysez votre cœur WordPress, vos thèmes et vos extensions à la recherche de CVE connues depuis la ligne de commande. Open source, auditable, respectueux de la vie privée — propulsé par l'API CVE de ValtersIT.
Pour vous faciliter la prise en main de GitLab, voici une liste d'étapes suivantes recommandées.
Déjà un pro ? Modifiez simplement ce README.md et faites-en le vôtre. Vous voulez que ce soit simple ? Utilisez le modèle en bas de page !
cd existing_repo
git remote add origin https://gitlab.com/valtersit/wordpress-cve-scanner.git
git branch -M main
git push -uf origin main
Utilisez l'intégration continue intégrée à GitLab.
Lorsque vous êtes prêt à personnaliser ce README, modifiez simplement ce fichier et utilisez le modèle pratique ci-dessous (ou structurez-le comme vous le souhaitez - ce n'est qu'un point de départ !). Merci à makeareadme.com pour ce modèle.
Chaque projet est différent, alors réfléchissez aux sections qui s'appliquent au vôtre. Les sections utilisées dans le modèle sont des suggestions pour la plupart des projets open source. Gardez également à l'esprit qu'un README peut être trop long et détaillé, mais trop long vaut mieux que trop court. Si vous pensez que votre README est trop long, envisagez d'utiliser une autre forme de documentation plutôt que de supprimer des informations.
Choisissez un nom explicite pour votre projet.
Faites savoir aux gens ce que votre projet peut faire concrètement. Fournissez du contexte et ajoutez un lien vers toute référence qui pourrait être inconnue des visiteurs. Une liste de fonctionnalités ou une sous-section Contexte peut également être ajoutée ici. S'il existe des alternatives à votre projet, c'est un bon endroit pour lister les facteurs différenciants.
Sur certains README, vous pouvez voir de petites images qui transmettent des métadonnées, comme le fait que tous les tests du projet passent ou non. Vous pouvez utiliser Shields pour en ajouter à votre README. De nombreux services proposent également des instructions pour ajouter un badge.
Selon ce que vous créez, il peut être judicieux d'inclure des captures d'écran ou même une vidéo (vous verrez fréquemment des GIF plutôt que de véritables vidéos). Des outils comme ttygif peuvent aider, mais jetez un œil à Asciinema pour une méthode plus sophistiquée.
Au sein d'un écosystème particulier, il peut exister une manière courante d'installer les choses, comme utiliser Yarn, NuGet ou Homebrew. Cependant, considérez la possibilité que la personne qui lit votre README soit débutante et souhaite davantage de conseils. Lister des étapes précises aide à lever l'ambiguïté et permet aux gens d'utiliser votre projet le plus rapidement possible. S'il ne s'exécute que dans un contexte spécifique, comme une version particulière d'un langage de programmation ou un système d'exploitation, ou s'il a des dépendances qui doivent être installées manuellement, ajoutez également une sous-section Prérequis.
Utilisez des exemples à profusion et montrez le résultat attendu si possible. Il est utile d'avoir en ligne le plus petit exemple d'utilisation que vous pouvez démontrer, tout en fournissant des liens vers des exemples plus sophistiqués s'ils sont trop longs pour être raisonnablement inclus dans le README.
Indiquez aux gens où ils peuvent trouver de l'aide. Cela peut être n'importe quelle combinaison d'un gestionnaire de tickets, d'un salon de discussion, d'une adresse e-mail, etc.
Si vous avez des idées de versions futures, il est judicieux de les lister dans le README.
Indiquez si vous êtes ouvert aux contributions et quels sont vos critères pour les accepter.
Pour les personnes qui souhaitent apporter des modifications à votre projet, il est utile d'avoir de la documentation sur la façon de commencer. Peut-être y a-t-il un script qu'elles doivent exécuter ou des variables d'environnement qu'elles doivent définir. Rendez ces étapes explicites. Ces instructions pourraient également être utiles à votre futur vous.
Vous pouvez également documenter les commandes pour linter le code ou exécuter les tests. Ces étapes aident à garantir une haute qualité de code et réduisent la probabilité que les modifications cassent quelque chose par inadvertance. Disposer d'instructions pour exécuter les tests est particulièrement utile si cela nécessite une configuration externe, comme démarrer un serveur Selenium pour tester dans un navigateur.
Montrez votre reconnaissance à ceux qui ont contribué au projet.
Pour les projets open source, indiquez comment ils sont licenciés.
Si vous n'avez plus l'énergie ou le temps pour votre projet, ajoutez une note en haut du README indiquant que le développement a ralenti ou complètement cessé. Quelqu'un pourrait choisir de forker votre projet ou se porter volontaire pour intervenir en tant que mainteneur ou propriétaire, permettant à votre projet de continuer. Vous pouvez également faire une demande explicite de mainteneurs.