Esteja você iniciando um projeto de software completamente novo ou desejando adotar uma abordagem “ Docs as Code ” com sua documentação no GitHub, uma das primeiras etapas é criar um repositório (repo). Veja como isso é feito.
Por que criar um repositório GitHub?
Git é um sistema de controle de revisão distribuído de código-fonte aberto que permite que vários desenvolvedores ( e escritores !) Façam e rastreiem constantes e consecutivamente alterações no código ou na documentação em um local centralizado sem substituir o trabalho de outra pessoa. Este controle de versão faz com que, se algo quebrar, você possa facilmente localizar a origem do problema e reverter para uma versão de trabalho antes que o código problemático seja enviado.
Também é bom para rastrear quem contribuiu com o quê e quando. Isso é especialmente importante quando várias pessoas de fusos horários diferentes estão contribuindo para um projeto.
Ao criar um repositório GitHub, você traz esses benefícios para o seu projeto. Além disso, se você permitir que seu repo seja aberto ao público, outros podem contribuir – seja isso envolvendo consertar código quebrado ou até mesmo fazer correções em erros de digitação. Você pode até conseguir lançar uma versão beta funcional antes do previsto. O código aberto é uma coisa linda.
Como criar um repositório GitHub
Para configurar um projeto no GitHub, você precisará criar um repo. Para fazer isso, faça login (ou crie ) sua conta GitHub. Uma vez logado, clique no ícone “+” no lado direito do menu do cabeçalho (que pode ser acessado de qualquer lugar do site). Selecione “Novo Repositório” no menu suspenso que aparece.
Agora você estará na página “Criar um Novo Repositório”. Escolha o proprietário do repo e dê a ele um nome curto e fácil de lembrar. Lembre-se de que o nome do repo deve ser compatível com URL. Embora não haja uma convenção estrita, a maneira mais popular é usar todas as letras minúsculas enquanto separa as palavras com um hífen, como example-repo-name. Se você usar espaços no nome, um hífen será adicionado em seu lugar.
Depois de nomear seu repo, forneça uma breve descrição e escolha se deseja torná-lo público ou privado.
Em seguida, você pode:
- Adicionar um arquivo README : apresente e explique como usar e contribuir com seu projeto.
- Adicionar .gitignore : Escolha quais arquivos ignorar.
- Escolha uma licença : deixe que outras pessoas saibam o que podem ou não fazer com o código do seu projeto.
Estes são opcionais, mas altamente recomendados para adicionar. Quando estiver pronto, clique em “Criar Repositório”.
Seu repo foi criado.
Depois de criar um repo, você pode cloná-lo em sua máquina local , o que permite fazer edições no conteúdo localmente, em vez de diretamente nos arquivos de origem do repo.
