CONTRIBUTING.md

Guia de Contribuição

Olá, seja bem vindo!

Este guia é indispensável para entender como contribuir com este repositório. Leia atentamente todos o conteúdo para não restar dúvida alguma 😉

Aqui no @pagarme, encorajamos qualquer tipo de contribuição: de código à documentação, sempre com o foco de oferecer as melhores ferramentas da melhor empresa de pagamentos do Brasil. Quem sabe você não se torna o próximo pagarmer?

Como Contribuir com este Repositório

Encontrou um bug?

• Primeiro, certifique-se se o bug não está presente na nossa lista de issues.
• Se não conseguiu encontrar nenhuma issue reportando esse problema, crie uma. Lembre-se de incluir título e descrição claros, com toda informação possível, como logs, screenshots, etc, com todos os passos necessários para reproduzir o bug.

Escreveu uma correção para um bug/issue?

• Ótimo! Antes de enviar qualquer alteração, certifique-se de ler este documento por completo. Então, crie um novo Pull Request com sua correção.

Corrigiu espaços, indentação, ou fez qualquer outra mudança mais cosmética?

Não descartamos esse tipo de alteração, porém damos prioridade à features mais críticas. Isso não te impede de seguir com seu Pull Request 😉

Abrindo um novo Pull Request

• Vamos analisar todo o código envolvido, portanto, antes de enviar seu Pull Request, tenha certeza que ele atende os seguintes requisitos:
  • Seguir os padrões de código conhecidos por PSR;
  • Deve manter e/ou aumentar nossa cobertura de testes, onde usamos ferramentas padrão como:
    • PHPUnit;
    • Behat.
  • Deve obter com sucesso a revisão das seguintes ferramentas automáticas:
    • Travis para execução de testes a cada Pull Request;
    • SensioLabs Insight para inspecionar nossa qualidade de código.
• Assim que criar seu Pull Request, em seguida marque um dos membros do Pagar.me para revisão.

Atribuição

Este Contributing é adaptado do Código de Conduta do Contributor Covenant, version 1.4, disponível em http://contributor-covenant.org/version/1/4