Contribuindo para a microestrutura PIMF

Este tutorial explica os princípios básicos de contribuição para um projeto no GitHub por meio da linha de comando. O fluxo de trabalho pode se aplicar à maioria dos projetos no GitHub, mas, neste caso, estaremos focados no projeto PIMF. Este tutorial é aplicável a OSX, Linux e Windows. Este tutorial assume que você instalou o Git e criou uma conta no GitHub. Se ainda não o fez, dê uma olhada na documentação do PIMF no GitHub para se familiarizar com os repositórios e ramos do PIMF.

Bifurcação PIMF

Faça login no GitHub e visite o Repositório PIMF. Clique no botão Fork. Isso criará seu próprio fork do PIMF em sua conta GitHub. Seu fork PIMF estará localizado em https://github.com/username/pimf (seu nome de usuário GitHub será usado no lugar do nome de usuário).

Clonagem PIMF

Abra a linha de comando ou terminal e crie um novo diretório onde você pode fazer alterações de desenvolvimento para PIMF:

mkdir pimf-develop
cd pimf-develop

Em seguida, clone o repositório PIMF (não o fork que você fez):

git clone https://github.com/gjerokrsteski/pimf.git .

Nota: O motivo pelo qual você está clonando o repositório PIMF original é – você sempre pode puxar para baixo as alterações mais recentes do repositório PIMF para o seu repositório local.

Adicionando seu garfo

Em seguida, é hora de adicionar o fork que você fez como um repositório remoto:

git remote add fork git@github.com:username/pimf.git

Lembre-se de substituir o nome de usuário ** pelo seu nome de usuário do GitHub. * Isso diferencia maiúsculas de minúsculas. Você pode verificar se o garfo foi adicionado digitando:

git remote

Agora você tem um clone puro do repositório PIMF junto com seu fork como um repositório remoto. Você está pronto para começar a ramificar para novos recursos ou corrigir bugs.

Criação de ramos

Primeiro, certifique-se de estar trabalhando no ramo de desenvolvimento. Se você enviar alterações para o branch master, é improvável que elas sejam puxadas em um futuro próximo. Para obter mais informações sobre isso, leia a documentação do PIMF no GitHub. Para mudar para o ramo de desenvolvimento:

git checkout develop

Em seguida, você deseja certificar-se de que está atualizado com o repositório PIMF mais recente. Se qualquer novo recurso ou correção de bug tiver sido adicionado ao projeto PIMF desde que você o clonou, isso garantirá que seu repositório local tenha todas essas alterações. Essa etapa importante é a razão pela qual originalmente clonamos o repositório PIMF em vez de seu próprio fork.

git pull origin develop

Agora você está pronto para criar um novo branch para seu novo recurso ou correção de bug. Ao criar uma nova ramificação, use uma convenção de nomenclatura autodescritiva. Por exemplo, se você for corrigir um bug no cache Pimf Util , nomeie o bug / cache do seu branch:

git branch bug/caching
git checkout bug/caching

Mudou para branch ‘bug / caching’

Nota: Crie um novo branch para cada novo recurso ou correção de bug. Isso encorajará a organização, limitará a interdependência entre novos recursos / correções e tornará mais fácil para a equipe do PIMF mesclar suas alterações no núcleo do PIMF. Agora que você criou seu próprio branch e mudou para ele, é hora de fazer suas alterações no código. Adicione seu novo recurso ou corrija esse bug.

Comprometendo

Agora que você terminou de codificar e testar suas alterações, é hora de confirmá-las em seu repositório local. Primeiro, adicione os arquivos que você alterou / adicionou:

git add pimf/bug/caching

Em seguida, envie as alterações para o repositório:

git commit -s -m "I added some more stuff to the caching."

• -s significa que você está assinando seu commit com seu nome. Isso informa à equipe do PIMF que você concorda pessoalmente com a adição do seu código ao núcleo do PIMF.
• -m é a mensagem que acompanha seu commit. Forneça uma breve explicação do que você adicionou ou alterou.

Empurrando para o seu garfo

Agora que seu repositório local tem suas alterações confirmadas, é hora de enviar seu novo branch para o fork que está hospedado no GitHub:

git push fork feature/caching

Seu branch foi enviado com sucesso para sua bifurcação no GitHub.

Enviando uma solicitação pull

A etapa final é enviar uma solicitação pull ao repositório PIMF. Isso significa que você está solicitando que a equipe PIMF extraia e mescle suas alterações no núcleo do PIMF. Em seu navegador, visite seu fork PIMF em https://github.com/username/pimf . Clique em [Solicitação de pull]. Em seguida, certifique-se de escolher os repositórios e branches base e head adequados:

• repo base: pimf / pimf
• ramo base: desenvolver
• head repo: username / pimf
• branch principal: feature / [nome do seu recurso]

Use o formulário para escrever uma descrição mais detalhada das alterações feitas e por que as fez. Finalmente, clique em [Send pull request]. É isso aí! As alterações feitas foram enviadas à equipe PIMF. Qual é o próximo?

Você tem outro recurso que deseja adicionar ou outro bug que precisa ser corrigido? Primeiro, certifique-se de sempre basear seu novo branch fora do branch de desenvolvimento:

git checkout develop

Em seguida, baixe as alterações mais recentes do repositório do PIMF:

git pull origin develop

Agora você está pronto para criar um novo branch e começar a codificar novamente!