CONTRIBUTING.md

Quero contribuir, como faço?

Olá futuro(a)(e) contribuidor(a)(e), já de antemão quero lhe agradecer pelo interesse em contribuir para o HoCo viu!

Para começar a contribuir no nosso projeto por favor leia esse documento atentamente, ele abrange desde pessoas que nunca contribuiram em um projeto OpenSource até pessoas que já são programadores a um tempo, então espero que você consiga contribuir com o projeto da sua forma 🙂.

Contribuindo

Caso você queira contribuir e não saiba com o que exatamente por favor dê uma olhada na página issues do nosso repositório, caso existam algumas issues abertas você pode pedir nos comentários da issue para ter o assign nela, significando que você vai ficar responsável por tentar resolver aquele problema com um tempo de duas a três semanas.

As issues não servem apenas para verificar como você pode contribuir com o projeto, caso você encontre algum bug , pensou em alguma refatoração ou uma adição legal ao projeto, por favor crie uma nova issue explicando o motivo de você estar criando ela.

Good First Issue

As issues com a tag good first issue são issues que os mantainers do projeto pensaram que seriam boas issues para quem nunca contribuiu começar a contribui, sendo assim, caso você ja seja um programador(a)(e) experiente por favor deixe essas issues para programadores mais inexperientes, com elas essas pessoas podem começar uma jornada muito massa no mundo da contribuição open source!

Fizeram assign da issue para mim...e agora?

Bom, agora você já pode começar a implementar e para isso crie um fork do repositório.

Quando você faz um fork o GitHub cria uma cópia do repositório principal em um dos seus repositórios e é nesse repositório que você pode trabalhar na resolução da sua issue.

⚠️ OBS: fique atento(a)(e) nos commits hein! Faça commits significativos para que seja possível entender o que o código que foi commitado faz a partir da mensagem do commit.

Pronto, terminada a sua implementação, com seus commits bonitinhos, faça o push para o seu repositório forkado e faça um pull request

Ta, mas o que é um Pull Request?

O pull request é o seu pedido para que o código que você implementou seja fundido ao repositório principal.

Para criar um Pull Request (PR) basta que você vá na pagina dos pull requests no repositório principal do projeto, Link do repositório principal), e clique em "new pull request". Preencha as informações requisitadas no form padrão da PR e marque pelo menos dois mantainers para revisarem a sua PR, depois de duas aprovações a sua PR será fundida ao projeto principal.

Mantainers atuais: @rodrigoec, @leandraos, @claudiodantas ou @gustafss

Espero que você contribua bastante hehe! Tchau tchau