Article image
Elidiana Andrade
Elidiana Andrade21/04/2022 21:20
Compartilhe

5 Dicas para Melhorar seu Profile README do GitHub

  • #GitHub

Na maioria dos casos, a primeira impressão está vinculada ao que é apresentado no perfil. Então nada melhor do que organizar de uma maneira harmônica e autêntica essa apresentação prévia aos demais usuários. Pensando nisso, resolvi separar algumas dicas para melhorar o README do seu perfil GitHub.


Caso ainda não saiba como adicionar um README ao seu perfil, é bem simples:

  1. Crie um novo repositório no Github;
  2. Nomeie o repositório com o seu nome de usuário do GitHub.

1. Escreva uma breve descrição sobre você

Fale um pouco sobre você. É interessante ser objetivo e falar a área que atua e/ou seus objetivos.

2. Cite suas skills e redes sociais utilizando Badges

Uma forma de sintetizar e tornar mais objetiva a descrição sobre você, é adicionando Badges para citar suas skills, redes sociais e/ou ferramentas que utiliza, separando por tópicos.

2.1 Personalizando as Badges

Você pode conferir os parâmetros para personalização em https://shields.io/. Nesse caso, eu utilizei o estilo style=for-the-badge e alterei a cor do fundo inserindo o código hexadecimal da cor após o nome (nesse caso Discord), separado por - Discord-6B6D80, e alterei a cor da logo adicionando &logoColor=61dafb.

Antes

image

![Alt](https://img.shields.io/badge/Discord-CCC?style=flat&logo=discord)

Depois

image

![Alt](https://img.shields.io/badge/Discord-000?style=for-the-badge&logo=discord&logoColor=7289DA)

3. Adicione uma ilustração ou imagem que você se identifique

image

No meu perfil, por exemplo, optei por utilizar essa ilustração que encontrei no Freepik, pois trouxe vários elementos que se conectam comigo.

Um dos pontos foi o desktop, a maioria das ilustrações que eu encontrava eram desenvolvedores em notebook, e me identifiquei com essa porque utilizo desktop. Além disso, tem o café preto quentinho (a única diferença é que mantenho ele longe do computador 🤣).

3.1 Sites com imagens para uso gratuito

Alguns dos sites onde você pode conseguir imagens para uso gratuito são o Freepik e o Pexels. No caso do Freepik, é necessário atribuir os créditos, já no Pexels a maioria das imagens não necessita de atribuição.

4. Defina uma paleta de cores harmônica

Caso não tenha uma paleta definida, mas queira utilizar alguma ilustração ou imagem, tome partido da paleta de cores existentes nela para deixar o perfil mais harmônico. Você pode utilizar algum editor de imagem, extensão, ou qualquer outro método para obter o código das cores presentes.

4.1 Geradores de paleta de cores online

Outra opção ainda mais simples é utilizar um gerador online, onde você pode inserir uma imagem e gerar uma paleta de cores a partir dela, utilizar alguma existente, ou criar a sua. Algumas opções são:

4.2 Pense no contraste Dark/Light

Ao escolher sua paleta, lembre-se do contraste que as cores adotadas geram nos modos dark / light tendo em vista os diferentes tipos de usuários que vão visitar o seu perfil. Outro ponto também é o fundo da imagem, nesse caso deixei transparente para não ficar o fundo branco liso no modo dark.


image

5. Adicione o GitHub Stats

Confira o repositório GitHub Readme Stats para ver todos os parâmetros de personalização e os temas disponíveis.

5.1 Deixando o fundo com efeito gradiente

Basta adicionar bg_color=angulo,cor1,cor2, nesse caso utilizei bg_color=30,FFF,D6DAFF com o tema jolly, borda branca border_color=FFF e texto preto text_color=000:

image

![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=SEUNOMEDEUSUARIO&show_icons=true&include_all_commits=true&count_private=true&bg_color=30,FFF,D6DAFF&border_color=FFF&text_color=000&theme=jolly)

5.2 Ocultar o título GitHub Stats

Basta adicionar &hide_title=true para ocultar o título:

image

![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=SEUNOMEDEUSUARIO&show_icons=true&include_all_commits=true&count_private=true&bg_color=30,FFF,D6DAFF&border_color=FFF&text_color=000&theme=jolly&hide_title=true)

DICA BÔNUS: Cuidado com os excessos!

Como dizia Mies van der Rohe: Menos é mais! Cuidado para não se empolgar e encher o perfil com muitas coisas, deixando ele carregado e muitas vezes ilegível pelo volume de informações. Selecione o que for mais importante e principalmente adicione cores harmônicas.


Este artigo foi útil para você?

Dê um upvote e me conta nos comentários o que você achou 😊💜

image image image image

Compartilhe
Comentários (19)
Cassiana Barreto
Cassiana Barreto - 03/09/2023 17:38

Bacana demais, eu já comecei a melhorar o meu README profile. Obrigada!

Bruno Pereira
Bruno Pereira - 26/08/2023 15:14

Muito boa dica !

Manuella Oliveira
Manuella Oliveira - 22/08/2023 17:22

Massa demais, Eli!!!!!!

Iolanda Rocha
Iolanda Rocha - 18/08/2023 21:04

Genial, Eli!

Estou gostando muito das suas aulas.

Muito obrigada.

Elidiana Andrade
Elidiana Andrade - 04/07/2022 20:04

Obrigada, Renê Arruda!

Renê Arruda
Renê Arruda - 04/07/2022 19:17

Chegando agora, mas gostei muito! obrigado

André Alves
André Alves - 29/04/2022 15:59

Dicas legais. Já estou te seguindo!

Dorany Braga
Dorany Braga - 29/04/2022 15:55

Amei o artigo, Elidiana! Vou te acompanhar no GitHub. Seria legal você criar um repositório no GitHub com as dicas passadas aqui, assim é possível favoritar seu projeto.

SM

Sidnei Mourão - 29/04/2022 15:52

Amei, vou copiar.

Bianca Paccola
Bianca Paccola - 25/04/2022 11:30

bom dia! eu não sei mexer muito bem ainda, mas usei seu perfil para me inspirar e coloquei seu perfil nos créditos. TD bem ?

JOAO BARBOSA
JOAO BARBOSA - 22/04/2022 14:20

Obrigado pelo conteúdo.

Ismael Brito
Ismael Brito - 22/04/2022 02:27

Que massa!

Eduardo Mello
Eduardo Mello - 21/04/2022 21:31

Ótimo Conteúdo Parabéns!!

DF

Domingos Ferreira - 21/04/2022 21:28

Artigo muito bom e as dicas tambem Elidiana.

Lucas Carvalho
Lucas Carvalho - 21/04/2022 21:23

Gostei muito das dicas, dá até vontade de deixar o meu readme mais bonito 🤣

Elidiana Andrade
Elidiana Andrade - 30/04/2022 16:27

Obrigada, gente! Obrigada pela dica, Dorany! Eu estava colocando num repositório onde devo construir um blog mais para frente, vou atualizar o artigo com o link 🥰

Elidiana Andrade
Elidiana Andrade - 25/04/2022 16:02

Oii Bianca! Tudo bem! Me passa o seu para eu te seguir! 😊 Se tiver alguma dúvida sobre como alterar, pode perguntar também.

Elidiana Andrade
Elidiana Andrade - 22/04/2022 17:06

Por nada!! Agradeço pelos comentários 😊

Elidiana Andrade
Elidiana Andrade - 21/04/2022 21:45

Obrigada a todos! 😊