Usando o GitHub

Este tutorial do GitHub é carinhosamente baseado no DjangoGirls How To Contribute Tutorial que está disponível sob uma licença Creative Commons Attribution-ShareAlike 4.0.

Para este tutorial, usaremos o repositório repositório Briefcase como base para os links e referências.

Introdução e pré-requisitos

Para contribuir com o BeeWare, é necessário o seguinte para começar:

• uma [conta do GitHub] (https://github.com)
• no caso de edições complexas, familiaridade com linha de comando do Git básica ou familiaridade com um aplicativo (Windows e Mac) para enviar suas edições feitas em seu computador para o GitHub.

Faça o fork do repositório

Primeiro, bifurque o repositório Briefcase em sua conta pessoal do GitHub:

Edição de documentação

Mudanças simples

Para alterações simples, como correções de erros de digitação, você pode usar o editor on-line do GitHub editor:

• Abra sua página de bifurcação local no GitHub,
• vá para o arquivo README.rst em qualquer capítulo,
• pressione o ícone Edit (caneta)

e você pode editar o capítulo diretamente no github.com.

A sintaxe RST é usada para editar as páginas individuais da documentação.

Observação

Salve suas alterações e crie uma solicitação pull conforme explicado abaixo.

Novo código e alterações complexas

Para adicionar novos códigos, estender classes ou fazer alterações complexas, você precisa obter uma cópia do código em seu computador local.

Use o aplicativo GitHub para o seu sistema operacional (mencionado acima) ou a linha de comando linha de comando git para obter o repositório localmente. Você obtém o endereço do repositório na página inicial de sua própria bifurcação do repositório do GitHub:

git clone git@github.com:yourusername/briefcase.git

Em seguida, crie uma ramificação para suas novas alterações. É útil chamar o ramo de algo relacionado às alterações que você vai fazer.

git checkout -b update_documentation

Faça quaisquer alterações no código e certifique-se de que elas sejam testadas e salvas localmente.

Em seguida, faça o commit das alterações usando git e envie as alterações para seu repositório remoto do repositório remoto do GitHub.

Exemplo:

$ git status
No ramo update_documentation
Arquivos não rastreados:
  (use "git add <arquivo>..." para incluir no que será enviado)

    README.rst

git add README.rst

$ git commit -m "Atualizar a documentação README.rst do Briefcase"
[update_documentation fe36152] Adicionada captura de tela do gitbook
 1 arquivo alterado, 0 inserções (+), 0 exclusões (-)
 modo de criação 100644 README.rst

$ git push
Contagem de objetos: 11, concluído.
Compressão delta usando até 8 threads.
Compactando objetos: 100% (5/5), concluído.
Gravação de objetos: 100% (5/5), 266,37 KiB | 0 bytes/s, concluído.
Total 5 (delta 1), reutilizado 0 (delta 0)
Para git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

Fazendo uma solicitação pull

Depois de concluir suas alterações, você precisa criar [uma solicitação pull request] (https://help.github.com/articles/about-pull-requests/) no GitHub. O BeeWare será notificado sobre a solicitação pull, revisará suas alterações, sugerirá correções, se necessário, e então pull suas alterações para a versão principal.

Em seu próprio repositório no GitHub, pressione Compare & pull request

Preencha as informações por que essa alteração está sendo feita. O revisor pode ver os detalhes da alteração real, portanto, você não precisa repetir o conteúdo da alteração.

Em seguida, pressione Create pull request.

Os e-mails do GitHub o notificarão sobre o processo de acompanhamento.

---