Este material foi originalmente postado no Habr.com em russo. O autor permitiu que fosse traduzido e publicado no Codingsight.
Talvez todos tenham em algum lugar um arquivo para manter certas coisas interessantes e úteis, como links para artigos, livros, repositórios, manuais, etc. Você pode usar marcadores em um navegador ou guias, ainda abertos e esperando por você. Com o tempo, tudo cresce excessivamente, os links se quebram e os materiais ficam obsoletos.
Mas e se pudéssemos compartilhar essas pérolas perspicazes com a comunidade? Carregar um arquivo para o GitHub? Então, suas descobertas seriam úteis para outra pessoa. Além disso, seria mais fácil manter o arquivo atualizado em conjunto, atualizando a lista através das boas e velhas pull requests.
É para isso que temos o projeto Awesome Lists.
Awesome Lists está entre os 10 melhores repositórios do GitHub, já possuindo 138k “estrelas”, e um link para seus trabalhos pode torná-lo seu README raiz, atraindo grandes audiências. No entanto, você terá que fazer algum esforço primeiro. Aqui, quero compartilhar minha experiência.
Sou Maksim Gramin, desenvolvedor Java e pesquisador de banco de dados da CROC, uma empresa internacional de TI com sede em Moscou. Este artigo falará sobre listas impressionantes e como criar seu repositório oficial incrível.
O que são listas incríveis?
Sempre que tenho que lidar com alguma nova tecnologia ou linguagem de programação, vou lá primeiro, procurando a seção necessária e as listas apropriadas. Dado o grande e cada vez maior número de “estrelas”, não sou a única pessoa com tal abordagem.
Na verdade, “Awesome Lists” é um readme.md simples padrão que vive em um repositório separado. No entanto, ocupa a 8ª posição entre todos os repositórios do GitHub e inclui outras listas dedicadas a determinados tópicos. Por exemplo, a seção Linguagens de Programação tem listas Awesome Python e Awesome Go, enquanto a seção Desenvolvimento Front-End armazena vários materiais de desenvolvimento Web. Por último, mas não menos importante, há a seção Banco de Dados (falaremos sobre isso um pouco mais tarde).
Obviamente, o conteúdo não se limita apenas a assuntos técnicos e também inclui outras seções, como Entretenimento e Jogos. Você pode encontrar muitas coisas interessantes lá também (fiquei muito feliz com a lista de fantasias incríveis).
A principal diferença do projeto é que todas essas listas são gerenciadas não apenas pelo autor, mas pela comunidade. Além disso, todos eles são feitos de acordo com um Manifesto Impressionante rigoroso. Cada lista representa uma comunidade separada de especialistas, vivendo sua própria vida e estando aberta para seus pull requests, o que a tornará ainda melhor. Além disso, qualquer pessoa pode criar sua própria lista caso algum tópico não seja explorado.
Pela ideia original e coordenação de tudo isso, devemos ser gratos ao lendário Sindre Sorhus, o primeiro homem no GitHub e autor de mais de 1.000 módulos npm. Ele é quem vai aceitar seus pull requests.
Como fazer uma lista incrível
Se você não encontrou a lista certa para o tópico necessário, é o primeiro sinal de que você deve fazer isso sozinho! Eu vou te dizer como fazer isso pelo exemplo de minha própria criação – Awesome Database Tools.
Projeto por projeto, tive que lidar com todos os tipos de bancos de dados. Assim, passei a gerenciar alguns arquivos onde reuni diferentes ferramentas úteis para o trabalho. Havia vários migradores de banco de dados, IDE, painéis de administração, ferramentas de monitoramento, etc., incluindo aqueles que eu já usava ou apenas planejava.
Eu compartilhei este arquivo com meus colegas do CROC e além, encorajado por ver como isso beneficiou muitos deles. Então, eu queria mais. Quando notei que a seção de Bancos de Dados não tinha uma lista dedicada às ferramentas, decidi adicionar a minha.
O que você precisa para isso?
- Registre um repositório padrão do GitHub e nomeie-o como awesome-smth - no meu caso, foi awesome-database-tools.
- Ajuste a lista para o incrível formato usando generator-awesome-list que irá gerar todos os arquivos necessários no formato correto.
- Configure a integração contínua (CI) – awesome-lint e Travis CI nos ajudarão a controlar a validade da lista.
- Aguarde 30 dias.
- Revise pelo menos duas outras solicitações de pull.
- Faça um pull request para o repositório principal e adicione um link para nosso próprio repositório. Importante :leia atentamente todos os vários requisitos da nova lista e solicitações pull e siga-os com precisão.
Minha primeira tentativa não deu certo.
No entanto, depois de algum tempo, coletei mais materiais, fiz minha lição de casa, corrigi os erros e tentei uma segunda vez.
Mas esqueci uma coisa crucial, e eles me lembraram educadamente:
Eu não estava atento o suficiente e não adicionei um unicórnio como confirmação de que todas as condições estavam sendo cumpridas.
Mais algum tempo se passou, recebi mais algumas observações e acrescentei emendas e, finalmente, vi um twit tão esperado que meu PR havia sido aceito.
Foi assim que fiz minha primeira lista e comecei a receber os pull requests da comunidade para adicionar novas ferramentas. Muitos deles já estão incluídos no Awesome Database Tools.
Se você tiver boas ideias para bancos de dados, sinta-se à vontade para compartilhá-las. Além disso, ficarei feliz em receber seus comentários, como solicitações de pull e estrelas. Se você tiver alguma dúvida sobre como criar suas próprias listas, entre em contato.
Você pode entrar em contato com o autor em [email protected].
