👏😁 Antes de mais nada, muito obrigado por sua contribuição 👍
Este projeto e todos os participantes estão sob o regimento do Código de Conduta Vindi. Ao participar, espera-se que você mantenha este código.
Contribuições são muito bem vindas e serão totalmente creditadas.
Nós valorizamos muito as contribuições por Pull Requests (PR) em GitHub, mas também adoramos sugestões de novas features. Por isso, fique à vontade para reportar um bug 🚨 ou parabenizar 🎉 o projeto!
-
Branches separadas - Recomendamos que o PR não seja a partir da sua branch
master
. -
Um PR por feature - Se você deseja ajudar em mais de uma feature, envie múltiplos PRs 😁.
-
Clareza - Além de uma boa descrição sobre a motivação e a solução proposta é possível incluir imagens ou animações que demonstrem quaisquer modificações visuais na interface.
Exemplo de Motivação com uma Solução Proposta:
Motivação
Fazer com que o pedido seja cancelado, caso o pagamento seja reprovado na primeira tentativa (compras avulsas ou primeiro ciclo de uma assinatura), mas atualmente o cliente recebe a informação que o pedido foi registrado com sucesso, e posteriormente recebe a informação de falha no pagamento no Woocommerce.
Solução proposta
Adicionar o cancelamento automático de faturas na Vindi após a recusa de uma transação no Woocommerce, exceto: compras via Boleto ou pendente de revisões do Antifraude.
-
Foco - Um PR deve possuir um único objetivo bem definido. Evite mais de um viés (bug-fix, feature, refactoring) no mesmo PR.
-
Formatação de código - Não reformate código que não foi modificado. A reformatação de código deve ser feita exclusiva e obrigatoriamente nos trechos de código que foram afetados pelo contexto da sua alteração. Obs.: Gostamos muito do WordPress PHP Coding Standards 😄
-
Fragmentação - Quando um PR for parte de uma tarefa e não entregar valor de forma isolada, será necessário explicitar na motivação quais são os objetivos da tarefa, e na solução proposta, os objetivos que foram concluídos no PR em questão e os que serão concluídos em PRs futuros.
Se você nunca criou um Pull Request (PR) na vida, seja bem vindo 🎉 😄 Aqui está um ótimo tutorial de como enviar um.
-
Faça um fork do projeto, clone seu repositório (fork):
# Clone repositório (fork) na pasta corrente git clone https://github.com/<seu-username>/vindi-woocommerce # Navegue ate a pasta recém clonada cd vindi-woocommerce
-
Crie uma branch nova a partir da
master
que vai conter o "tipo/tópico" como nome da branch
-
tipos: feature e fix
git checkout -b feature/cria_metodo_pagamento
-
Faça um push da sua branch para seu repositório (fork)
git push -u origin feature/cria_metodo_pagamento
-
Abra um Pull Request com uma motivação e solução proposta bem claras.
A revisão deve verificar se o PR atende aos requisitos abaixo, na ordem que são apresentados, e a decisão final ficaria com a equipe Vindi quanto à prioridade:
- O código realmente faz o que o autor está propondo?
- O tratamento de erros está adequado?
- As modificações introduzem vulnerabilidades de segurança?
- Dados sensíveis estão sendo tratados da maneira correta?
- O código está legível?
- Métodos, classes e variáveis foram nomeadas apropriadamente?
- Os padrões definidos pelo projeto ou pela equipe estão sendo respeitados?
Feliz desenvolvimento!