Skip to content

Commit

Permalink
Contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
devdrops committed Jan 16, 2017
1 parent e8f2d0e commit eaa8889
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,45 @@
# 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 :wink:

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](/issues).
- Se não conseguiu encontrar nenhuma issue reportando esse problema, [crie uma](/issues/new). 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 :wink:


### 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](http://www.php-fig.org/psr/);
- Deve manter e/ou aumentar nossa cobertura de testes, onde usamos ferramentas padrão como:
- [PHPUnit](https://phpunit.de/);
- [Behat](http://behat.org/en/latest/).
- Deve obter com sucesso a revisão das seguintes ferramentas automáticas:
- [Travis](https://travis-ci.org/) para execução de testes a cada Pull Request;
- [SensioLabs Insight](https://insight.sensiolabs.com/) 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][homepage], version 1.4,
disponível em [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -20,3 +20,7 @@ $pagarMe = new \PagarMe\Sdk\PagarMe($apiKey);
```
### Wiki
Check the [wiki](https://github.com/pagarme/pagarme-php/wiki) for detailed documentation.

### Contributing

**Also** checkout our [contributing guide](CONTRIBUTING.md) before you send us any contribution.

0 comments on commit eaa8889

Please sign in to comment.