Seus repositórios precisam de ordem: Um guia de construção de um README.md bem feito
Alguém entra no seu github, pode ser até mesmo um recrutador, ele vai no seu projeto mais recente e… Do que se trata o projeto? Para responder essa pergunta eu sempre uso o README.md para desenvolver a capa do meu projeto de uma forma bem organizada.
Se você for no meu projeto mais recente no momento de escrita deste artigo (https://github.com/fransilva0/projeto-e-commerce-nextjs) você vai ver que eu começo com uma imagem mostrando a parte inicial do meu projeto, eu poderia colocar um gif mas optei por fazer isso quando concluir o projeto (se tiver um gif no momento da leitura eu provavelmente concluí, rsrs).
Por se tratar de uma imagem para um arquivo próprio do github e não do projeto em si, eu uso algo que aprendi vendo outros projetos e crio uma pasta .github para armazenar as imagens que for utilizar no README.
Abaixo da imagem eu adiciono um link chamado demo para apresentar o projeto funcionando. Após esse link eu finalmente escrevo o nome do projeto e sigo para o badges informativos. Esses badges podem ser encontrados neste site: https://shields.io/.
Quando o projeto está em construção ainda eu menciono isso com um texto do tipo: 🚧 Nome do Projeto 🚀 Em construção... 🚧. Abaixo disso ficam links âncoras para partes do README. A seção Sobre tem um texto informativo e comentários sobre o projeto, na seção funcionalidades eu faço uma to do list com funções que quero acrescentar e vou marcando as que já implementei.
Na seção tecnologias eu coloco links das documentações das tecnologias que eu usei no projeto em forma de lista não ordenada. Se existir algum pré-requisito para rodar o projeto no seu computador eu coloco em uma seção abaixo da de tecnologia e abaixo eu coloco a seção Começando com um pequeno tutorial para clonar e rodar o projeto em uma máquina local.
Por fim eu faço menção à licença, coloco uma mensagem fofinha e um link âncora para voltar para o início do README. Se você for no repositório que eu usei como exemplo pode pegar o código do README e utilizar como template para o seu projeto, é só ir modificando o conteúdo e daí por diante em outros projetos futuros. Deixo um abraço para você a até a próxima.
Você também pode gostar deste artigo: https://programacao-descomplicada.blogspot.com/2022/12/7-apostilas-gratuitas-de-programacao.html
