Por que contribuir para softwares open source?

---

Softwares open source servem para criar um ambiente de aprendizado diverso, em que é possível aprender , ensinar e criar experiência em qualquer habilidade.

Como contribuir

---

Existem diversas formas de contribuir para um software open source, seja no código , documentação , organização , design, entre outros. para contribuir para o nosso projeto, primeiramente leia o código de conduta encontrado aqui.
No nosso projeto são utilizadas as seguintes ferramentas para desenvolvimento do projeto:

Issue tracker : onde as pessoas discutem tarefas e problemas relacionadas ao projeto

Pull requests: onde as pessoas discutem e revisam as mudanças que estão em progresso

Como utilizar as ferramentes de contribuição

---

Antes de criar uma issue ou pull request é necessário:

comunicar suas inteções e suas ideias de forma efetiva, mostrando o que deseja fazer, o contexto por trás da idéia , e a utilidade dela para o projeto

olhar o README, as issues abertas e fechadas e outros canais de comunicação da comunidade

Abrindo uma issue

---

É necessário abrir uma issue nas seguintes situações:

Relatar um erro que você não consegue resolver sozinho

Discutir um tópico ou idéia de alto nível (visão da comunidade , políticas da comunidade, entre outros)

Propor uma nova feature ou uma ideia de projeto

ISSUE TEMPLATE

Comunicação correta em uma issue

No caso de uma issue que deseja resolver , comente na issue para que outros possam saber que está trabalhando nela

Se uma issue foi aberta há muito tempo é possível que ela esteja sendo resolvida em outro lugar ou já tenha sido resolvida, então é necessário comentar nela para pedir confirmação antes de começar a trabalhar

Se você abriu uma issue e posteriormente descobriu como resolvê-la, comente na issue e feche-a, para que outros possam saber que elá já foi realizada.

Abrindo um pull request

---

É necessário abrir um pull request nas seguintes situações:

Enviar correções triviais (um link quebrado , um erro simples e óbvio, entre outros)

Começar a trabalhar em uma contribuição que já foi pedida ou discutida através de uma issue

Vale destacar que um pull request não precisa representar um trabalho finalizado. Geralmente é melhor abrir um pull request no começo do desenvolvimento, para outros oferecerem feedback no seu progresso. Para isso, basta abrir ele como "draft" ou marcar ele como "WIP" (trabalho em progresso). É sempre possível adicionar commits depois

Como abrir um pull request

clone o repositório localmente, realize um git pull para manter no estado atual do repositório

crie uma branch para suas modificações

referencie alguma issue relevante ou documentação auxiliar para seu pull request (como por exemplo "fechando #21")

se seu pull request for relacionado a HTML/CSS, inclua imagens de antes e depois para comparação

teste suas modificações para não realizar mudanças prejudiciais ao projeto

contribua com o estilo do projeto da melhor forma possível , com os padrões e parâmetros já existentes

PULL REQUEST TEMPLATE