Esse é um tutorial para ajudar os contribuidores inicial a participar de um simples e fácil projeto.
- Fazer uma contribuição para um projeto Open Source.
- Ficar mais confortável usando o GitHub.
- Isto é para iniciantes absolutos. Se você sabe como escrever e editar uma tag de âncora
<a href="" target=""> </a>
, deve poder fazer isso. - Isto é para aqueles com um pouco mais de experiência mas que querem fazer a sua primeira contribuição para um Open Source, ou possuir mais contribuições para maior experiência e confiança.
Qualquer desenvolvedor web, aspirante ou experiente, precisa usar o controle de versão do Git, e o GitHub é o serviço de hospedagem Git mais popular usado por todos. É também o coração da comunidade Open Source. Ficar confortável com o GitHub é uma habilidade essencial. Fazer uma contribuição para um projeto aumenta sua confiança e oferece a você algo para mostrar no seu perfil do GitHub.
Se você é um novo desenvolvedor e está se perguntando se precisa aprender Git e GitHub, aqui está a resposta: Você deveria ter aprendido Git ontem.
Você contribuirá com um cartão como este para esta página de projetos. Ele incluirá seu nome, seu endereço no Twitter, uma breve descrição e três links para recursos úteis para os desenvolvedores da web que você recomenda.
Você fará uma cópia do modelo do cartão dentro do arquivo HTML e o personalizará com suas próprias informações.
Primeiro vamos configurar para fazer o trabalho
- Faça o login na sua conta do GitHub. Se você ainda não tem uma conta então entre no GitHub. Eu recomendo que você faça o GitHub Hello World tutorial antes de você continuar.
- Download GitHub Desktop.
- Como alternativa, se você estiver confortável usando o Git na linha de comando, faça isso (aqui está primeiras contribuições, um projeto semelhante que pode servir como um guia para os comandos necessários). OU
- Se você usa VS Code ele vem com o Git integrado e permite que você faça o que precisamos diretamente do editor.
- No entanto, a maneira mais simples e fácil de seguir este tutorial é usar o GitHub Desktop.
Agora que você está pronto, vamos continuar com o negócio de contribuir para o projeto.
Torne-se um contribuidor Open Source em 10 passos.
Tempos estimado: menos de 30 minutos.
- O objetivo aqui é fazer uma cópia desse projeto e colocar na sua conta.
- Um repositório (repo) é como o projeto é chamado no GitHub e o Fork é uma cópia dele.
- Garanta que você esteja na página principal desse repositório.
|
---|
- Agora você tem um cópia complete desse projeto na sua conta.
- Agora nós temos que fazer uma cópia local do projeto. Essa é uma cópia salva na sua máquina.
- Abra o Github Desktop. E no seu Aplicativo:
|
---|
- Isso levará um momento enquanto o projeto é copiado para o seu disco rígido. Eu recomendo que você mantenha o caminho padrão que geralmente é
.. \ Documents \ GitHub
. - Agora você tem uma cópia local do projeto.
- Depois que o repositório for clonado e você o abrir na área de trabalho do GitHub, é hora de criar um novo ramo.
- Uma ramificação é uma maneira de manter suas alterações separadas da parte principal do projeto chamada `Mestre '. Por exemplo, se as coisas derem errado e você não estiver satisfeito com as alterações, basta excluir a ramificação e o projeto principal não será afetado.
|
---|
|
---|
- Você pode dar o nome que desejar, mas como esse é um ramo para adicionar um cartão com o seu nome ao projeto, chamá-lo de `seu nome do cartão 'é uma boa prática, pois mantém clara a intenção desse ramo.
|
---|
- Agora você criou uma nova branch separada da master.
- Para as próximas etapas, verifique se você está trabalhando neste ramo. Você verá o nome da filial em que se encontra, na parte superior central do aplicativo de desktop do GitHub, onde diz Current branch.
Não trabalhe na branch master
- Agora precisamos abrir o arquivo que vamos editar com seu editor de código favorito.
- Encontre a pasta do projeto no seu computador. Se você manteve o padrão, deve ser algo como
seu-computador> Documentos> GitHub> Contribua para este projeto
- O arquivo
index.html
está diretamente na pastaContribute-To-This-Project
.
- Agora você tem o arquivo que deseja editar aberto no seu editor e está pronto para começar a fazer alterações.
- Faremos uma cópia do modelo do cartão para começar a trabalhar nele
- Agora esse é seu cartão para você personalizar e editar.
- Agora começaremos a editar o html, alterando os campos personalizáveis em nosso cartão.
|
---|
|
---|
- Se você preferir usar um contato que não seja o Twitter, será necessário substituir o ícone do twitter
<i class="fa fa-x-twitter"></i>
indo ao Font Awesome Icons procurando o ícone certo e substituindo apenas a partefa-x-twitter
pelo novo ícone comofa-facebook
por exemplo. Depois siga os mesmos passos acima.
|
---|
- Garanta que você salvou todas as suas mudanças.
- Teste suas mudanças. ISSO É IMPORTANTE!Abra o arquivo html no seu navegador (clicando duas vezes nele, por exemplo) e veja como será o seu cartão no site. Veja que a página inteira ainda parece a mesma e nada está quebrado. Clique nos seus links e verifique se eles estão funcionando.Abra o console (Ctrl + Shift + J (Windows / Linux) ou Cmd + Opt + J (Mac)) e verifique se não há mensagens de erro.
- Ótimo, você terminou de editar seu código! As próximas etapas enviarão suas alterações para o GitHub e as enviarão para serem mescladas com o projeto principal.
- Volte para o GitHub Desktop.
- Suas alterações serão adicionadas automaticamente à área de preparação.
- Isso significa que o Git registrou todas as alterações salvas.
- Você pode ver isso refletido no aplicativo. Tudo o que você adicionou ao arquivo ficará em verde e as exclusões aparecerão em vermelho.
|
---|
- Suas alterações agora estão salvas ou confirmadas. Mas eles são salvos apenas localmente, ou seja, no seu computador.
- A sincronização de alterações locais com seu repositório no Github é chamada de Push. Você está "enviando" as alterações do seu repositório local para o repositório remoto no Github.
|
---|
- Após alguns segundos, a operação está concluída e agora você tem exatamente a mesma cópia desta ramificação em sua máquina e no GitHub.
- Este é o momento que você estava esperando; enviando um Pull Request (PR).
- Até agora, todo o trabalho que você fez esteve na bifurcação do projeto, que, como você se lembra, reside em sua própria conta do GitHub.
- Agora é hora de enviar as alterações para o projeto principal a serem mescladas.
- Isso é chamado de Pull Request porque você está pedindo ao mantenedor do projeto original para "puxar" suas mudanças em seu projeto.
- Vá para a página principal de seu fork no GitHub (ele terá o ícone do fork e seu próprio nome de usuário na parte superior).
- Na parte superior do repositório, você verá uma mensagem destacada de solicitação de recebimento com um botão verde.
|
---|
|
---|
- Não se assuste com todas as opções. Você só precisa executar essas três etapas por enquanto.
- Deixe a opção "Permitir edições dos mantenedores" marcada.
- Agora, um Pull Request será enviado ao mantenedor do projeto. Assim que for revisado e aceito, suas alterações aparecerão na página da web do projeto.
É isso aí. Você conseguiu! Você já contribuiu para o código aberto no GitHub.
Você adicionou código a uma página da web ao vivo: [https://syknapse.github.io/Contribute-To-This-ProjectBody((https://syknapse.github.io/Contribute-To-This-Project)
Suas alterações não serão visíveis imediatamente; primeiro eles precisam ser revisados, aceitos e mesclados pelo mantenedor do projeto. Depois que eles forem mesclados, seu cartão estará visível e estará na página.
É muito normal que um revisor solicite alterações em um PR. Pense nisso como uma boa prática, se acontecer com você. Fique de olho nos comentários e nas alterações solicitadas. Depois de fazer as alterações solicitadas (de volta ao seu ramo), tudo o que você precisa fazer é confirmar e enviar as alterações. O PR será atualizado automaticamente com as novas alterações.
Prometo que tentarei revisar e mesclar o mais rápido possível, mas faço isso no meu tempo livre, por isso é inevitável um atraso de alguns dias.
- Volte em um tempo para verificar sua solicitação de solicitação mesclada.
- Você deve receber um email do GitHub quando suas alterações forem aprovadas ou se alterações adicionais forem solicitadas. E quando o PR for finalmente mesclado ao mestre e seu cartão foi adicionado.
- Se você achou este projeto útil, dê a ele: estrela: ⭐ no topo da página e Tweet sobre ele para ajudar a espalhar a palavra
- Você pode me seguir e entrar em contato no Twitter ou usando qualquer uma dessas outras opções
- Este é um projeto de código aberto. Além de contribuir com seu board, você pode ajudar a corrigir bugs, melhorias ou novos recursos. Abra um issue ou envie uma nova pull request
- Obrigado por contribuir com este projeto. Agora você pode ir em frente e tentar contribuir com outros projetos; procure o rótulo [ para obter opções de contribuição para iniciantes.
- Também estou procurando colaboradores para me ajudar na revisão e mesclagem de PRs. Se você deseja obter uma prática mais avançada do Git, envie-me um DM no Twitter.
Este projeto é fortemente influenciado por Roshan Jossey's ótimas primeiras contribuições em projetos com seu excelente tutorial.
Também é particularmente inspirado pela grande comunidade em torno de #GoogleUdacityScholars A bolsa de estudos do Desafio do Google: desenvolvedor Web front-end, turma da Europa de 2017.