Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

35 lines (19 loc) · 2.68 KB

Contributing

Fico muito feliz de ver que você se interessou nesse humilde projeto e ficaria muito animado com a sua contribuição. Então me dê sua mão e deixa eu te guiar por esse camnho.

Passo 1: Criando uma issue

Você olhou o projeto e pensou: "hum bacana, mas seria mais bacana ainda se eu pudesse visualizar os horários no próprio terminal, por exemplo"(seu sonho pode se tornar realidade!), ou mesmo você estava catucando o projeto e achou um bug ou um código que você sabe que pode ser implementado de um jeito melhor, essa é sua chance de mostrar seu valor! tudo que você precisa fazer é:

  • Abrir uma issue
  • Preencher os campos do template, deixando bem explicado o motivo e o que você quer que seja feito
  • Clique em Submit new Issue

Passo 2: Implementado a Issue

Se você é a alma caridosa que salvará todos nós da escuridão ou mesmo um ser independente que vai atrás de corrigir suas próprias issues, agora é com você que eu tô falando. Pra que isso não vire uma bagunça, vamos seguir esse único passo:

  • Se você viu uma Issue e quer implementar, manda uma mensagem na Issue pedindo que eu dou assign pra ti e todo mundo vai saber que já tem alguém empenhado nela!

Passo 3: Mãos a obra

Com o assign em mãos, você pode começar a trabalhar nela forkando o repositório para você, para isso clique no botão Fork e será gerado uma cópia do repositório em seu perfil. Com a cópia em mãos, você está livre para trabalhar e resolver a issue que você tanto almeja.

Passo 4: Pull Request

Ao finalizar a implementação da Issue, antes de tudo rode o comando de teste para garantir que tudo ainda está funcionando. Se o código passou, está na hora de abrir a famigerada Pull Request (ou PR, para os mais íntimos), você pode fazer isso clicando no botão New Pull Request, cheque se as branchs estão certas e clique em Create pull request.

Passo Bônus: Correção de PR

Você abriu a PR e já tava correndo pro abraço, mas as vezes nem tudo que você faz está perfeito e sem defeitos, é pra isso que existe a revisão de PR, onde um ou mais Maintainers (galera top do rolè) vão ver o que você fez e caso tenha algo errado ou algo podia ter sido feito de um modo melhor, eles avisam e você pode debater e tals. É um momento bacana de aprendizado. Após corrigir as possiveis alterações, você só precisa abrir um outro commit para a mesma branch da PR que ela será automaticamente atualizada!

Passo Final: Merge

Caso tudo esteja show de bola, sua PR será aceita e você terá ajudado um projeto open source a crescer!

Viu como é simples? sinta-se livre para abrir Issues e PRs que possam contribuir com o crescimente desse projeto :).