Ce matériel était à l'origine posté sur Habr.com en russe. L'auteur a autorisé sa traduction et sa publication sur Codingsight.
Peut-être que tout le monde a quelque part un fichier pour conserver certaines choses intéressantes et utiles, comme des liens vers des articles, des livres, des référentiels, des manuels, etc. Vous pouvez utiliser des signets dans un navigateur ou des onglets, toujours ouverts et vous attendant. Au fil du temps, tout cela se développe excessivement, les liens se brisent et les matériaux deviennent obsolètes.
Et si nous pouvions partager ces joyaux perspicaces avec la communauté ? Télécharger un fichier sur GitHub ? Ensuite, vos découvertes seraient utiles à quelqu'un d'autre. De plus, il serait plus facile de garder le fichier à jour ensemble, en mettant à jour la liste via les bonnes vieilles demandes d'extraction.
C'est pour cela que nous avons le projet Awesome Lists.
Awesome Lists fait partie des 10 meilleurs référentiels GitHub, avec déjà 138 000 « étoiles », et un lien vers vos œuvres peut remonter jusqu'à sa racine README, attirant ainsi un large public. Cependant, vous devrez d'abord faire des efforts. Ici, je veux partager mon expérience.
Je suis Maksim Gramin, développeur Java et chercheur en bases de données chez CROC, une société informatique internationale dont le siège est à Moscou. Cet article vous expliquera les listes impressionnantes et comment créer votre dépôt impressionnant officiel.
En quoi consistent les listes géniales ?
Chaque fois que je dois m'occuper d'une nouvelle technologie ou d'un langage de programmation, j'y vais d'abord, à la recherche de la section nécessaire et des listes appropriées. Compte tenu du nombre important et sans cesse croissant de "stars", je ne suis pas la seule personne à adopter une telle approche.
En fait, "Awesome Lists" est un fichier readme.md standard vivant dans un référentiel séparé. Cependant, il occupe la 8 position parmi tous les référentiels GitHub et comprend d'autres listes dédiées à certains sujets. Par exemple, la section Langages de programmation contient des listes Awesome Python et Awesome Go, tandis que la section Front-End Development stocke de nombreux supports de développement Web. Enfin, il y a la section Base de données (nous en reparlerons un peu plus tard).
Bien sûr, le contenu ne se limite pas aux seuls sujets techniques et comprend également d'autres sections, telles que Divertissement et Jeux. Vous pouvez y trouver beaucoup de choses passionnantes aussi (j'étais vraiment content de la liste super-fantasy).
La principale distinction du projet est que toutes ces listes sont gérées non seulement par l'auteur, mais par la communauté. De plus, ils sont tous fabriqués selon un strict Manifeste Awesome. Chaque liste représente une communauté distincte de spécialistes, vivant sa propre vie et étant ouverte à vos pull requests, ce qui la rendra encore meilleure. De plus, n'importe qui peut créer sa propre liste au cas où un sujet manquerait d'exploration.
Pour l'idée originale et la coordination de tout cela, nous devrions être reconnaissants au légendaire Sindre Sorhus, le premier homme sur GitHub et l'auteur de plus de 1 000 modules npm. C'est lui qui acceptera vos pull requests.
Comment créer une liste impressionnante
Si vous n'avez pas trouvé la bonne liste pour le sujet nécessaire, c'est le premier signe que vous devriez le faire vous-même ! Je vais vous dire comment le faire par l'exemple de ma propre création - Awesome Database Tools.
Projet par projet, j'ai eu affaire à toutes sortes de bases de données. Ainsi, j'ai commencé à gérer quelques dossiers où j'ai rassemblé différents outils utiles pour le travail. Il y avait divers migrations de bases de données, IDE, panneaux d'administration, outils de surveillance, etc., y compris ceux que j'utilisais déjà ou que je prévoyais d'utiliser.
J'ai partagé ce dossier avec mes collègues du CROC et au-delà, encouragé de voir comment cela a profité à beaucoup d'entre eux. Ensuite, j'en voulais plus. Lorsque j'ai remarqué qu'il manquait à la section Bases de données une liste dédiée aux outils, j'ai décidé d'ajouter la mienne.
De quoi avez-vous besoin pour cela ?
- Enregistrez un référentiel GitHub standard et nommez-le awesome-smth – dans mon cas, il s'agissait d'outils de base de données awesome.
- Ajustez la liste au génial format en utilisant generator-awesome-list qui générera tous les fichiers nécessaires au bon format.
- Configurer l'intégration continue (CI) – awesome-lint et Travis CI nous aideront à contrôler la validité de la liste.
- Attendez 30 jours.
- Examinez au moins deux autres demandes d'extraction.
- Effectuez une demande d'extraction vers le référentiel principal et ajoutez un lien vers notre propre référentiel. Important :Lisez attentivement toutes les nombreuses exigences relatives à la nouvelle liste et aux demandes d'extraction, et respectez-les scrupuleusement.
Ma première tentative n'a pas réussi.
Cependant, après un certain temps, j'ai rassemblé plus de matériel, fait mes devoirs, corrigé les erreurs et essayé une deuxième fois.
Mais j'ai oublié une chose cruciale, et ils me l'ont rappelé poliment :
Je n'ai pas été assez attentif et n'ai pas ajouté de licorne pour confirmer que toutes les conditions étaient remplies.
Un peu plus de temps a passé, j'ai reçu d'autres remarques et des modifications ajoutées, et, finalement, j'ai vu un twit tant attendu que mon PR avait été accepté.
C'est ainsi que j'ai fait ma première liste et commencé à recevoir les pull requests de la communauté pour l'ajout de nouveaux outils. Beaucoup d'entre eux sont déjà inclus dans Awesome Database Tools.
Si vous avez de bonnes idées pour les bases de données, n'hésitez pas à les partager. De plus, je serai heureux de recevoir des commentaires de votre part, comme des demandes d'extraction et des étoiles. Si vous avez des questions sur la création de vos propres listes, n'hésitez pas à me le faire savoir.
Vous pouvez joindre l'auteur à [email protected].
