Vou dar algumas dicas de como criar um perfil apresentável no GitHub.
- Faça parte de comunidades open source e contribua para elas. Os melhores projetos para fazer contribuição são aqueles que você usar ou já está familiarizado com as ferramentas, pacotes, aplicativos e até mesmo jogos.
- Tenha repositórios organizados.
- Não uso o mesmo repositório para dois guarda dois projetos diferentes.
- Crie um README, ele tem que ter minimo a descrição do software e instruções para instalações e como fazer o seu uso.
- Tenha uma padrão universal de organização dos tópicos de seu README (Você vai usar eles em outros projetos como ponto de partida).
- Para repositórios com o arquivo "package.json", recomendo usar o Package-Json-to-Readme ou Gen-README como ponto de partida do README.
- Faça commits que descrever a modificação realizada (Nada como "Update X.js" ou "up").
- Escolha uma licença, o site escolhaumalicenca.com.br pode ajuda você nisso.
- Não coloque muitos arquivos na raiz, o ideal seria você usar subdiretórios para organizar os arquivos.
- Use os "badges" para mostrar status do projeto. Há vários desses no site shields.io.
- Sempre que possível crie testes.
- Use ferramentas de CI (Continuar integração), para fazer build e roda testes. Recomendo usar o Travis CI a integração dele com GitHub é perfeita e ainda tem "badges"
- Tenha um site para seu projeto, assim fica mais fácil de acha ele fora do GitHub. Caso não queira ter o trabalho de criar um do zero use o GitHub Pages.
- Separe seus forks em uma organização. Dica: Você pode manter eles sempre atualizados usar o bot Pull.
- Não faça gambiarras :), lembre-se que o mundo todo vai ver seu código.
- Evite demorar muito responder issue ou pull requests.
- Tenha foto de perfil apresentável e uma rápida descrição.
Outras sugestões em github.com/training-center/forum/issues/23.
Top comments (6)
Muito massa seu post parabéns, vou poder melhorar muito meus projetos de hoje em diante, obrigado.
Se me permite uma "Issue" hehe..
Para repositórios com o arquivo "package.jsom", o correto não seria".json"?Exatamente, obrigado, já corrigir.
Boa noite, para quem acabou de sair da faculdade porem não aprendeu uma linguagem. Mas aprendeu bem os conceitos de logica,algoritmo e estrutura de dados.
e já estudou o básico de Python e js.
como começar na carreira de dev.
hj em dia trabalho como auxiliar noc na área de ti.
Ótimo guia Tiago! Bastante dica boa.
Cara, que artigo excelente! Era algo assim que estava procurando! Obrigado.
Achei vc na github e já estou seguindo!