Como devo proceder para preparar e carregar um projeto existente para o GitHub?
Nesta unidade, discutimos as considerações importantes para carregar um projeto no GitHub.
Porque é que deve carregar para o GitHub?
Há volumes de literatura exaltando as virtudes do GitHub, e está além do escopo deste módulo convencê-lo a participar. No entanto, neste módulo, recapitulamos alguns dos principais benefícios dentro do contexto de assuntos que você precisa considerar ao planejar seu upload.
Controlo de versões
O GitHub usa exclusivamente o Git, sem dúvida o melhor sistema de controle de versão do mercado. No entanto, o Git é incrivelmente sofisticado e pode criar alguns cenários complexos para trabalhar com código com os quais sua equipe pode não ter experiência. Os ramos e pedidos Pull são essenciais para programadores que utilizam o Git, pelo que é necessário compreender quando e como utilizá-los eficazmente para ser bem-sucedido no GitHub. Vale a pena para sua equipe primeiro estar familiarizada com o fluxo do GitHub para que você possa começar a trabalhar.
Manter o seu código na cloud
Uma grande quantidade de código de projeto ainda é armazenada exclusivamente em máquinas de desenvolvedores. Ao fazer upload para o GitHub, você está movendo seu código para a plataforma de nuvem do GitHub, onde os membros da equipe podem acessá-lo facilmente de qualquer lugar. Esta mudança oferece uma boa oportunidade para analisar a política da sua equipa para os tipos de ficheiros e dados que mantém no controlo de versões. Como prática recomendada, você deve assumir que qualquer coisa que você se comprometer com o GitHub está potencialmente comprometida. Portanto, certifique-se de não incluir dados confidenciais, como chaves de API, senhas ou outros arquivos que contenham informações comparáveis.
Nota
O GitHub oferece repositórios públicos e privados, bem como controlos de acesso granulares para diferentes partes de um repositório. Isso permite que você controle para quem seus projetos são visíveis, bem como quais ações um determinado usuário pode executar.
Colaboração
O GitHub oferece um excelente suporte de colaboração em equipa através de funcionalidades como problemas, pedidos Pull e análises de código. No entanto, o fluxo do GitHub pode diferir das práticas às quais sua equipe está acostumada atualmente. É uma boa ideia considerar como sua equipe pode se adaptar ao GitHub e se você deve ou não manter os processos existentes.
Se o seu projeto é um projeto de código aberto que permite colaboradores externos, não há opção melhor do que o GitHub para maximizar esses benefícios.
Carregar para o GitHub
Considerações sobre o plano
A consideração mais importante antes de realizar o seu carregamento para o GitHub é se precisa de manter qualquer coisa para além do estado atual da sua origem. Por exemplo, você pode usar uma planilha ou um software de gerenciamento de projetos para rastrear bugs que planeja corrigir. O suporte para migrar esses itens varia de acordo com a plataforma e geralmente está disponível em projetos da comunidade. Este módulo não abrange a migração desse tipo de dados.
Manipular arquivos binários atualmente armazenados em seu projeto
Como melhor prática, os repositórios do GitHub devem ser limitados aos ficheiros necessários para criar projetos. Evite o envio de grandes ficheiros binários, como artefactos. Os ficheiros binários como folhas de cálculo e apresentações são mais bem monitorizados em portais que compreendem como os publicar e como controlar as suas versões adequadamente. Se tiver de controlar as versões de grandes ficheiros binários, pondere utilizar a extensão Git LFS (Large File Storage) do Git.
Crie arquivos Git importantes como .gitignore
O Git suporta .gitignore arquivos para ajudar a aplicar políticas de arquivos de controle de versão. Esses arquivos definem os padrões de pesquisa usados para excluir arquivos e pastas do rastreamento de controle do código-fonte. O exemplo a seguir exclui recursivamente todas as pastas chamadas Bin ou bin, e seu conteúdo, do controle do código-fonte.
[Bb]in/
Saiba mais sobre como ignorar ficheiros no artigo Ignoring files (Ignorar ficheiros). Veja também a coleção de ficheiros .gitignore de arranque disponível em várias plataformas no repositório gitignore.
Há outros ficheiros frequentemente utilizados em projetos do GitHub para explicar diferentes políticas a consumidores e contribuidores em repositórios. Mesmo que o seu projeto seja privado e restrito a uma audiência limitada, pode continuar a ser útil para descrever estas políticas. Embora nenhum desses arquivos seja necessário, alguns dos comuns estão listados aqui.
| Ficheiro | Objetivo |
|---|---|
README.md |
A página de destino do diretório. Esta página é composta quando o diretório é visualizado no GitHub. |
LICENSE.md |
Este arquivo contém a licença sob a qual o código é fornecido. |
CONTRIBUTING.md |
Explica como os utilizadores devem contribuir para o projeto e define as expetativas de pedidos Pull. |
SECURITY.md |
Explica a política de segurança para o projeto. Este arquivo fornece orientação aos usuários que desejam enviar códigos confidenciais relacionados à segurança ou comentários que não devem ser divulgados publicamente antes de serem abordados. |
Saiba mais sobre como configurar o seu projeto para boas contribuições no artigo Setting up your project for healthy contributions (Configurar o seu projeto para boas contribuições).
Carregue seu projeto no GitHub
Assim que o repositório estiver preparado para upload, crie um repositório no GitHub. Depois de criar o repositório, navegue para o separador Code do seu repositório do GitHub. Esta vista fornece-lhe várias formas de carregar o código do seu projeto.
Recomendamos que você use o cliente git ou uma ferramenta amigável ao Git para carregar sua fonte. Em alternativa, pode carregar os seus ficheiros manualmente com a ligação Criar um ficheiro novo. A longo prazo, é provável que você descubra que usar um cliente git é a melhor maneira de gerenciar mudanças, ramificações e muito mais.