Como criar um readme incrível no seu perfil do GitHub
Fala pessoal, tudo bem?
Você sabia que no GitHub, há uma funcionalidade que permite que seja criado um repositório que você pode adicionar uma apresentação, com as stacks que você trabalha, suas experiências, portfólio, redes sociais e afins?
Como por exemplo, quando um usuário acessar o seu perfil, ele ter acesso a um repositório logo na página inicial:
Esse repositório, se feito de forma inteligente e estratégica com informações relevantes, com certeza vai auxiliar os recrutadores na hora de te enviar uma proposta de emprego, caso tenha interesse em seu trabalho.
Antes de tudo, o que é um README?
O README.md é um arquivo com extensão .md (Markdown). Nele contém as informações que são necessárias para entender o objetivo do projeto, no nosso caso, terá as informações profissionais.
Readme é uma palavra em inglês que significa leia-me.
Como ativar a funcionalidade em meu perfil?
Pra ativar essa funcionalidade “secreta”, basta você criar um repositório com o seu nome de usuário, por exemplo, o nome do meu usuário no github é @lucalves, o nome do repositório seria lucalves.
Assim que for colocado o nome do seu usuário no repositório, irá aparecer uma janela com a informação que você descobriu um “segredo” e que esse é um repositório especial que ficará em seu perfil.
Não esqueça de marcar a opção “Add a README file”.
Perfeito! Após criar o repositório com o nome de seu usuário e acessar seu perfil, o repositório estará na página inicial. Agora vamos falar de algumas dicas pra deixar-lo mais interessante:
1. Utilize badges
Uma badge, nada mais é que um pequeno “distintivo” com um visual pequeno e interessante. Por exemplo, você pode adicionar uma badge para cada uma de suas redes sociais, pro seu e-mail, e afins.
Um site interessante que faz a geração dessas badges, é o shields.io. O repositório do projeto você pode conferir clicando aqui. Dentro do readme do projeto tem explicando como você pode gerar uma badge personalizada de acordo com sua necessidade.
Estes são exemplos de badges que você pode incluir em seu perfil:
2. Inclua um status geral
O que acha de incluir informações sobre seu perfil no readme, como por exemplo o status das linguagens que você mais utilizou, o total de commits realizados e o total de issues e pull requests abertos?
E o melhor, com diversas opções de temas pra cada gosto específico e tudo isso sendo atualizado dinamicamente. Os temas disponíveis até a data de criação desse artigo, são:
O repositório com o código responsável por gerar esses status dinamicamente, é o repositório github-readme-stats, pode ser consultado clicando aqui.
3. Utilize emoticons
O uso de emoticons em seu perfil, deixa o conteúdo mais bonito e mais “leve” visualmente, e pode ser interessante incluir-los em seu readme. Um exemplo de utilização no perfil, seria dessa forma:
Uma lista completa de emoticons pode ser conferida nesse gist, clicando aqui.
Concluímos!
Se o artigo e as dicas foram interessantes pra você, ou caso tenha alguma dúvida relacionado ao mesmo, deixe um comentário e também não esqueça de deixar seu aplauso ou “clap” aqui no Medium, isso me incentiva a continuar criando conteúdos pra comunidade de desenvolvedores.
Conecte-se também comigo no LinkedIn, clicando aqui.
E acompanhe os projetos no GitHub clicando no link abaixo:
