Importância do README
Olá, pessoal.
Eu participei do Next Level Week, da Rocketseat, onde criei um site agregador de links e salvei no github. Numa das aulas do evento, o professor fez questão de ressaltar a importância de se ter um bom README no projeto, e nesse artigo eu vou explicar pra vocês o porque.
O que é?
README é, por convenção, um arquivo de marcação de texto (markdown) contendo as principais informações sobre o seu projeto. Ele funciona como um documento técnico que explica de forma objetiva as principais questões sobre o seu repositório, como:
- Nome;
- Descrição;
- Preview;
- Link de acesso;
- Ferramentas;
- Colaboradores;
Esses foram alguns pontos para se listar, mas lembre-se de adaptá-los conforme a sua necessidade.
Conclusão
Esse foi apenas um pequeno resumo do que eu aprendi na trilha explorer do NLW e pensei que seria legal compartilhar com vocês. Recomendo que pesquisem sobre o assunto da forma que acharem melhor e apliquem esse conhecimento na hora de dar commit nos projetos aqui na DIO, porque vai fazer MUITA diferença. Obrigado se você leu até aqui e obrigado pro meu professor da trilha explorer do NLW, o Mayk Brito. Esse cara é fera. Até mais.
