Como fazer para preparar e carregar um projeto existente no GitHub?

• 8 minutos

Nesta lição, discutimos as considerações importantes para carregar um projeto no GitHub.

Por que carregar no GitHub?

Há muitos artigos, livros e informações destacando as virtudes do GitHub, e não é o objetivo deste módulo tentar convencê-lo a utilizá-lo. No entanto, neste módulo, resumimos alguns dos principais benefícios no contexto dos temas que você precisa considerar ao planejar seu upload.

Controle de versão

O GitHub usa exclusivamente o Git, comprovadamente o melhor sistema de controle de versão disponível. No entanto, o Git é incrivelmente sofisticado e pode criar alguns cenários complexos para trabalhar com códigos com os quais sua equipe talvez não tenha experiência. Branches e solicitações de pull são uma parte fundamental do dia a dia dos desenvolvedores que usam o Git, portanto entender quando e como usá-los efetivamente é necessário para ter êxito no GitHub. Vale a pena que sua equipe primeiro esteja familiarizada com o fluxo do GitHub para que você possa partir para a ação.

Mantenha seu código na nuvem

Grande parte dos códigos de projeto ainda são armazenados exclusivamente nos computadores de desenvolvedores. Ao carregar no GitHub, você está movendo seu código para a plataforma de nuvem do GitHub, na qual os membros da equipe podem acessá-lo facilmente de qualquer lugar. Essa mudança oferece uma boa oportunidade de examinar a política da sua equipe para os tipos de arquivos e dados que você mantém no controle de versão. Como melhor prática, você deve partir do pressuposto de que tudo que você fizer commit para o GitHub estará potencialmente comprometido. Portanto, não inclua dados confidenciais, como chaves de API, senhas ou outros arquivos que contêm informações similares.

Colaboração

O GitHub oferece excelente suporte para colaboração em equipe por meio de recursos como emissões, solicitações de pull e revisões de código. No entanto, o fluxo do GitHub talvez seja diferente das práticas com as 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 projeto é de código aberto e permite colaboradores externos, não há opção melhor que o GitHub para maximizar esses benefícios.

Upload no GitHub

Considerações sobre o plano

O mais importante a se considerar antes de executar seu upload no GitHub é se você precisa manter alguma coisa além do estado atual da sua origem. Por exemplo, você pode usar uma planilha ou um software de gerenciamento de projetos para acompanhar os bugs que planeja corrigir. O suporte para migrar esses itens varia conforme a plataforma e está em disponibilidade geral nos projetos da comunidade. Este módulo não aborda a migração desse tipo de dados.

Manipular arquivos binários armazenados no seu projeto no momento

Como uma melhor prática, os repositórios do GitHub devem estar limitados aos arquivos necessários para criar projetos. Evite confirmar arquivos binários grandes, como artefatos de compilação. Arquivos binários como planilhas e apresentações são mais adequados para serem acompanhados nos portais que sabem como atendê-los e como controlar a versão deles corretamente. Se você precisar realizar o controle de versão de arquivos binários grandes, considere usar a extensão Git Git LFS (Armazenamento de Arquivos Grandes).

Criar arquivos Git importantes como .gitignore

O Git dá suporte a arquivos .gitignore para ajudar a impor políticas de arquivo de controle de versão. Esses arquivos definem os padrões de pesquisa usados para excluir arquivos e pastas do acompanhamento do controle de código-fonte. O exemplo a seguir exclui recursivamente qualquer pasta chamada Bin ou bin e o conteúdo delas, do acompanhamento do controle do código-fonte.

[Bb]in/

Saiba mais sobre como Ignorar arquivos. Confira também a coleção de arquivos .gitignore iniciais oferecidos para várias plataformas no repositório gitignore.

Há vários outros arquivos comumente usados em projetos do GitHub para explicar políticas diferentes para consumidores e colaboradores do repositório. Mesmo que seu projeto seja privado e esteja restrito a um público-alvo limitado, ele ainda pode ser útil para articular essas políticas explicitamente. Embora nenhum desses arquivos seja necessário, alguns dos mais comuns estão listados aqui.

Arquivo	Finalidade
README.md	A página de aterrissagem do diretório. Esta página é renderizada quando o diretório dela é exibido no GitHub.
LICENSE.md	Esse arquivo contém a licença sob a qual o código é fornecido.
CONTRIBUTING.md	Explica como os usuários devem colaborar para o projeto, como expectativas de solicitação de pull.
SECURITY.md	Explica a política de segurança do projeto. Este arquivo fornece diretrizes para usuários que desejam enviar código ou comentários confidenciais relacionados à segurança que não devem ser divulgados publicamente antes de serem tratados.

Saiba mais sobre como Configurar seu projeto para contribuições íntegras.

Carregar seu projeto no GitHub

Depois que o repositório estiver preparado para upload, crie um repositório no GitHub. Depois de criado, navegue até a guia Código do seu repositório do GitHub. Essa exibição oferece várias maneiras de fazer upload do código do seu projeto.

É recomendável usar o cliente git ou uma ferramenta própria para o Git para carregar sua origem. Como alternativa, é possível carregar manualmente os arquivos usando o link criar um arquivo. Ao longo do tempo, você provavelmente descobrirá que usar um cliente git é a melhor maneira de gerenciar alterações, branches e muito mais.