Hey les débutants,
Félicitations pour faire votre chemin à l’open source. C’est une grande communauté.
C’est un peu déroutant au départ. Comment contribuer, où contribuer, problèmes, bugs, PR, PR, PR!
ne vous inquiétez pas, en vous impliquant dans l’open source, vous apprendrez tout.
Mais aujourd’hui, je voudrais vous donner à tous quelques conseils que je n’ai jamais reçus quand j’ai commencé mon voyage open source.
j’ai commencé à contribuer à l’open source et à mettre tous mes petits projets parallèles sur GitHub il y a quelque temps., À l’époque, je ne connaissais pas la partie README. Le temps a passé et j’ai commencé à suivre certains développeurs kickass. Sans aucun doute, ils avaient tous des projets incroyables, mais la chose la plus courante était que tous leurs projets avaient un README génial et c’est ainsi que j’ai appris l’importance d’un bon README.
STOP!! Je ne suis pas intéressé à lire sur votre parcours open source. Dites-moi juste comment écrire un bon README.
Cool. Alors voilà-
avant de commencer à mettre vos projets impressionnants sur GitHub, je veux que vous alliez lire d’abord sur le développement piloté par Readme.,
Pourquoi devrais-je me soucier d’un README?
la communauté Open source se développe rapidement. Les développeurs publient chaque jour de nouveaux projets open-source sur GitHub. En conséquence, il devient de plus en plus difficile de faire en sorte que votre propre projet se démarque de la mer des logiciels open source. Cependant, vous pouvez faire quelques choses pour augmenter vos chances d’attirer l’attention des autres développeurs. Une technique efficace et simple consiste à créer un fichier README agréable et utile.
votre README devrait être aussi bon que votre projet., Un excellent fichier README aide votre projet à se démarquer de la mer des logiciels open source sur GitHub.
un README est comme le visage de votre projet. C’est le premier fichier qu’une personne devrait lire lorsqu’elle rencontre un arbre source, et il devrait être écrit comme une introduction très brève et très basique au logiciel.
Un projet sans README n’est pas si utile. Jetons un coup d’œil à ce projet, par exemple.
Pas de README, pas de description, Pas de rien. Vous n’aurez aucune idée de ce que ce gars a construit, peu importe à quel point c’est génial.,
Maintenant, nous allons jeter un oeil à ce projet. L’auteur a mentionné des instructions détaillées et claires sur le projet et donc plus faciles à utiliser et à essayer pour les autres.
un bon README est également un bon moyen d’aider les gens à s’engager dans le projet. Un projet avec une belle lecture et des captures d’écran attirera mieux l’attention des utilisateurs car c’est un moyen direct d’expliquer pourquoi ce projet est important et pourquoi les gens devraient l’utiliser et contribuer au projet. Good README devrait également inclure suffisamment de détails pour aider un nouvel utilisateur à démarrer, par exemple, comment compiler, comment l’installer et comment l’intégrer.
Ok. Assez de parler. Montrez-moi comment écrire un bon README alors.
maintenant que vous convenez que le README compte, je vais vous dire comment en écrire un. Il n’est pas si difficile. Vous avez juste besoin de rester avec quelques puces. Voici quelques-uns des points que vous devez garder à l’esprit lors de la rédaction D’un README.
mise en forme de README?,
maintenant que vous avez appris vous-même comment et quoi écrire dans un README, parlons un peu du style de README aka formatage.
le formatage est une partie essentielle de README. Vous pouvez en apprendre davantage sur la façon de formater votre README ici et ici.
en fin de compte, Gardez à l’esprit —
Vous n’avez pas besoin d’aller au développement complet piloté par Readme, vous n’avez pas besoin d’inclure toutes ces puces , vous n’avez pas besoin de suivre un processus particulier. Mais écrire un bon README améliorera certainement vos compétences en documentation, Ce qui fera de vous un meilleur développeur.,
Leave a Reply