cryptoadvocate/dcsgonefwbspLe dépôt du package de support de carte du firmware du premier projet de badge électronique de Circuit Crafters.
Pour faciliter votre prise en main de GitLab, voici une liste d'étapes recommandées.
Déjà un·e pro ? Modifiez simplement ce README.md et personnalisez-le. Vous voulez faire simple ? Utilisez le modèle en bas de page !
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Utilisez l'intégration continue intégrée dans GitLab.
Quand vous êtes prêt·e à personnaliser ce README, modifiez ce fichier et utilisez le modèle pratique ci-dessous (ou n'hésitez pas à 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 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 que même si un README peut être trop long et détaillé, il vaut mieux qu'il soit 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 spécifiquement. Fournissez un contexte et ajoutez un lien vers toute référence que les visiteurs pourraient ne pas connaître. 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 de différenciation.
Sur certains README, vous pouvez voir de petites images qui transmettent des métadonnées, comme par exemple si tous les tests passent pour le projet. Vous pouvez utiliser Shields pour en ajouter à votre README. De nombreux services fournissent également des instructions pour ajouter un badge.
Selon ce que vous réalisez, il peut être judicieux d'inclure des captures d'écran ou même une vidéo (vous verrez souvent des GIFs plutôt que des vidéos réelles). Des outils comme ttygif peuvent aider, mais découvrez Asciinema pour une méthode plus sophistiquée.
Dans un écosystème particulier, il peut y avoir 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 novice et souhaite des conseils supplémentaires. 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 fonctionne que dans un contexte spécifique comme une version particulière de 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 Exigences.
Utilisez des exemples généreusement et montrez le résultat attendu si possible. Il est utile d'avoir en ligne le plus petit exemple d'utilisation que vous puissiez 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 tourner pour obtenir de l'aide. Il peut s'agir de toute combinaison d'un suivi des problèmes, d'un salon de discussion, d'une adresse e-mail, etc.
Si vous avez des idées pour des versions futures, c'est une bonne idée de les lister dans le README.
Indiquez si vous êtes ouvert·e aux contributions et quelles sont vos exigences pour les accepter.
Pour les personnes qui souhaitent apporter des modifications à votre projet, il est utile d'avoir une documentation sur la façon de commencer. Il peut y avoir un script qu'elles doivent exécuter ou des variables d'environnement à 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 accidentellement quelque chose. Avoir des 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 les tests dans un navigateur.
Montrez votre reconnaissance à ceux qui ont contribué au projet.
Pour les projets open source, indiquez comment il est licencié.
Si vous n'avez plus d'énergie ou de temps pour votre projet, placez une note en haut du README indiquant que le développement a ralenti ou s'est arrêté complètement. Quelqu'un pourrait choisir de forker votre projet ou se porter volontaire pour devenir mainteneur ou propriétaire, permettant ainsi à votre projet de continuer. Vous pouvez également faire une demande explicite de mainteneurs.