Blog Formação DEV

Dicas para um bom README de perfil no GitHub

Você sabia que é possível adicionar um README ao seu perfil no GitHub? Esse arquivo serve como uma apresentação sua para a comunidade, e neste artigo você encontra uma série de dicas sobre como fazer um bom README de perfil.
Dicas para um bom README de perfil no GitHub
Texto de: Letícia Garcez

Introdução

Já faz algum tempo que o GitHub implementou a possibilidade de você ter uma espécie de landing page, ou página de apresentação no seu perfil do GitHub. Eu gosto muito deste recurso e como é através dele que você vai se apresentar para as pessoas que estão acessando o seu perfil, é importante estruturar esse arquivo de uma maneira de vá te beneficiar, e nesse artigo vamos discutir um pouco sobre como fazer isso.

Criando o repositório do README

Para criar a sua landing page, tudo o que você precisa fazer é criar um repositório que tenha o mesmo nome que o seu nome de usuário no GitHub e adicionar um arquivo README.md nesse repositório. E pronto, esse README será aplicado automaticamente ao seu perfil.

Esse arquivo README.md que você adicionou no repositório é um arquivo markdown normal, onde você pode colocar imagens, listas, etc. e você pode personalizá-lo conforme os pontos listados no resto deste artigo, ou da forma que preferir.

Língua

A primeira coisa que precisamos decidir é a língua que vamos usar para o README. Atualmente vemos muitas discussões na comunidade de desenvolvimento sobre a língua que deve ser utilizada para nomear variáveis e documentação de código, e essa discussão acaba se alastrando também para os READMEs dos seus projetos no GitHub.

Muitas pessoas defendem que todo o seu perfil e seus projetos devem ser feitos em inglês, e embora existam sim pontos positivos para o uso da língua inglesa, o uso dessa língua pode ser problemático se você não tiver domínio dela, já que seria a adição de mais uma camada de complexidade no desenvolvimento dos seus projetos.

A escolha na língua que você utilizará no seu README está muito ligada ao que você deseja nesse momento para a sua carreira. Se você estiver pensando em aplicar para vagas no mercado internacional, com certeza vale a pena o esforço de deixar seu perfil em inglês, mas caso você não tenha esse objetivo, recomendo utilizar o português como língua dos seus READMEs mesmo.

Apresentação

Agora que a língua do README já está decidida, você pode começar o README do seu perfil por uma breve apresentação sobre você. Essa apresentação pode ser bem genérica contendo seu nome, o que você estuda ou com o que trabalha, alguma informação que ache relevante ou um fato divertido, enfim, uma mensagem para que a pessoa que está abrindo o seu perfil saiba quem você é.

Skills

Listar as suas habilidades, ou as tecnologias que você tem mais contato é uma prática comum em READMEs de perfil. Com isso, é possível identificar facilmente as suas habilidades, o que facilita bastante quem está fazendo o processo de recrutamento, ou para quem queira entrar em contato contigo para falar sobre algum projeto, além é claro do apelo estético que estas listas podem ter se bem feitas.

Para listar as suas habilidades existem algumas formas, você pode usar uma lista em markdown com as tecnologias e habilidades que acha mais relevante, ou então utilizar alguns badges como as que podem ser encontradas em VishwaGauravIn/pretty-readme-badges e alexandresanlim/Badges4-README.md-Profile. Esses badges são imagens que podem ser adicionadas no seu README com muita facilidade, representando as tecnologias com as quais você trabalha. Além dos badges, você também pode encontrar ícones que representem as tecnologias com as quais você trabalha em sites como simpleicons.org e devicon.dev.

Você pode selecionar as tecnologias que quer exibir no seu perfil como preferir, mas caso você esteja aplicando para vagas em uma stack específica, eu recomendo que você evidencia essa stack no seu perfil de alguma forma.

Status

Após listar as suas skills, você pode adicionar alguns cards com estatísticas que podem ajudar quem está vendo o seu perfil a entender melhor o seu desempenho dentro da plataforma. Claro que esses números muitas vezes não têm uma relação com o quanto de código você realmente produz ou então com a qualidade do seu código, mas é um atrativo visual muito interessante.

O repositório mais famoso desses cards é o repositório anuraghazra/github-readme-stats. Os cards podem ser personalizados com diferentes temas e podem ter algumas informações ocultadas, permitindo que você escolha quais tópicos gostaria de evidenciar no seu perfil.

Alguns outros recursos que você pode utilizar no seu README podem ser encontrados nos repositórios abaixo:

O que mais você quiser!

O perfil do GitHub é seu, e você tem total liberdade para usá-lo de maneira a se expressar melhor e a passar melhor a ideia de quem você é e o que gosta de fazer. Se quiser inserir algo sobre sua experiência profissional ou acadêmica, incluir redes sociais, indicar um projeto que está trabalhando no momento ou simplesmente colocar uma foto do seu cachorro ou gato, faça! Desde que faça sentido dentro do seu texto, obviamente.

Algo que você pode fazer também é olhar perfis de outras pessoas para ver como elas estruturaram os seus perfis. Assim você vai ter uma ideia melhor do que você acha relevante ou não para o seu perfil.

Considerações finais

Neste artigo vimos algumas dicas sobre o README de perfil e alguns tópicos que podem ser adicionados a esse tipo de arquivo. O README de perfil é um arquivo muito importante e com certeza você deveria dedicar um pouco do seu tempo para deixar este arquivo organizado, já que um bom README de perfil pode fazer diferença em um processo seletivo, por exemplo.

Veja também

Sobre o autor
Cod3r

Cod3r

Com mais de 400 mil alunos, a Cod3r é uma das principais escolas de tecnologia do País. Um de seus produtos mais importantes é a Formação DEV, com objetivo de preparar os profissionais para o mercado.

Ótimo! Inscreveu-se com sucesso.

Bem-vindo de volta! Registou-se com sucesso.

Assinou com sucesso o Blog Formação DEV .

Sucesso! Verifique o seu e-mail para obter o link mágico para se inscrever.

As suas informações de pagamento foram atualizadas.

Seu pagamento não foi atualizado.