
Analyse les applications Ruby/Rails via Gemfile.lock — compare les gems à la base de données CVE de ValtersIT
Pour vous faciliter la prise en main de GitLab, voici une liste des prochaines étapes recommandées.
Déjà un expert ? Modifiez simplement ce README.md et personnalisez-le. 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/ruby-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, il vous suffit de modifier ce fichier et d'utiliser le modèle pratique ci-dessous (ou de le structurer 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 déterminez lesquelles de ces sections 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 qu'il vaut mieux trop long 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 ne pas être familière aux 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 réussissent 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 consultez Asciinema pour une méthode plus sophistiquée.
Au sein d'un écosystème particulier, il peut exister une manière courante d'installer des choses, comme l'utilisation de Yarn, NuGet ou Homebrew. Cependant, considérez la possibilité que la personne qui lit votre README soit débutante et souhaite davantage d'orientations. Lister des étapes spécifiques 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 abondamment et montrez le résultat attendu si possible. Il est utile d'inclure 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 se rendre pour obtenir de l'aide. Cela peut être n'importe quelle combinaison d'un outil de suivi des tickets, d'une salle 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 quelles sont vos exigences pour les accepter.
Pour les personnes qui souhaitent apporter des modifications à votre projet, il est utile de disposer d'une documentation expliquant comment démarrer. Il existe peut-être 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 le démarrage d'un serveur Selenium pour tester dans un navigateur.
Exprimez votre gratitude envers celles et ceux qui ont contribué au projet.
Pour les projets open source, indiquez sous quelle licence ils sont distribué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 s'est complètement arrêté. Quelqu'un pourrait choisir de forker votre projet ou se proposer comme mainteneur ou propriétaire, permettant ainsi à votre projet de continuer. Vous pouvez également formuler une demande explicite de mainteneurs.