10 Erros para evitar na hora de criar seu README
- #GitHub
1. Falta de Informações: no seu README é importante ter informações sobre você, como suas habilidades, projetos, interesses e como as pessoas podem entrar em contato com você.
2. README vazio: é muito importante que o seu README esteja preenchido com informações pois nele é onde se deve apresentar e compartilhar seu trabalho.
3. Informações desnecessárias: Evite deixar o README com informações demais. Tente sempre ser o mais objetivo possível.
4. Layout Desorganizado: Um layout desorganizado desestimula a leitura dificultando a compreensão do seu README. Links que podem te ajudar a ter um bom layout: https://www.markdownguide.org/ e https://readme.so/pt/editor .
5. Links Quebrados: Verifique se todos os links inseridos no README estão funcionando corretamente, sempre visualize seu README antes de salvar.
6. Falta de Coerência no Estilo: Use um estilo consistente do seu README, como por exemplo usar apenas uma paleta de cores, um título principal grande e os demais menores.
7. Ausência de Imagens/Gráficos: A arte visual sempre será mais chamativa que um texto, mas use com moderação para não fazer uma poluição visual.
8. Informações Pessoais: Evite incluir suas informações pessoais, como seu endereço e redes sociais do seu uso que estão incompatíveis com o seu profissional. Vou dar um exemplo óbvio: colocar seu link do Twitter, onde você posta que “odeia trabalhar” entre outras postagens do tipo. O WhatsApp é opcional, se você possui um só para o profissional é ótimo, deve colocar, mas se possuir apenas o pessoal vai de você querer expor seu número ou não.
9. Códigos Complexo: Não foque em códigos longos e complexos, mantenha-o preferencialmente curto, objetivo e com uma explicação adequada.
10. Conteúdo Desatualizado: seu README deve sempre estar atualizado, após você adicionar novos projetos ou adquirir novas habilidades, imediatamente atualize seu README para mostrar suas mudanças.
