docs: updating project docs

.github/bug_report.md

@@ -0,0 +1,11 @@
+# Bug
+
+### Descrição
+Descreva detalhadamente o bug.
+
+### Como reproduzir
+Descreva os passos para reproduzir o bug.
+
+### Evidências
+Colocar aqui as evidências do bug.
+

.github/contributing.md

@@ -0,0 +1,35 @@
+# Contribuição
+
+Primeiramente, obrigado por dedicar seu tempo para contribuir!
+
+### Como posso contribuir?
+
+* Faça um fork do projeto;
+* Faça suas alterações;
+* Use o padrão de commits;
+* Crie o pull request para a branch **develop**;
+
+### Pull Requests
+
+Template para os [pull requests](https://github.com/pagarme/woocommerce/blob/master/.github/pull_request_template/pull_request_template.md).
+
+### Mensagens de commit
+
+* As mensagens devem ser feitas em inglês
+* Utilizar o [conventional commits](https://www.conventionalcommits.org/pt-br/v1.0.0/), abaixo segue alguns exemplos de explicações:
+
+| Nomeclatura | Quando utilizar                          |
+|--------|------------------------------------------|
+| **feat:** | Para novas funcionalidades               |
+| **fix:** | Para correções de bugs                   |
+| **docs:** | Para atualização de uma documentação     |
+| **refactor:** | Para refatoração de um código            |
+| **perf:** | Para mudanças que melhoram a performance |
+
+Abaixo seguem alguns exemplos de commits:
+
+* feat: adding exclude saved credit card to customer
+* fix: pix qr code not showing in e-mail
+* docs: adding contribution section in readme
+* refactor: moving credit card javascript code to requirejs file
+* perf: removing unnecessary order update when access admin order page

.github/feature_request.md

@@ -0,0 +1,4 @@
+# Nova funcionalidade
+
+### Descrição
+Descreva detalhadamente a nova funcionalidade.

.github/pull_request_template/branches/master.md

@@ -0,0 +1,8 @@
+## :sparkles: New Features
+-
+
+## :bug: Bug fixes
+-
+
+## :rocket: Improvements
+-

.github/pull_request_template/pull_request_template.md

@@ -0,0 +1,18 @@
+![Git Merge](https://media.giphy.com/media/cFkiFMDg3iFoI/giphy.gif)
+
+> [!IMPORTANT]
+> Certifique-se de criar o PR para a branch **develop**.
+
+### Qual o tipo de PR é esse? (marque todos os aplicáveis)
+- [ ] Refatoração
+- [ ] Adição de funcionalidade
+- [ ] Correção de bug
+- [ ] Otimização
+- [ ] Atualização de documentação
+
+### Descrição
+Descreva brevemente as alterações feitas neste PR.
+
+
+### Cenários testados
+Descreva brevemente quais foram os cenários testados com as alterações feitas neste PR.

docs/README.md

@@ -1,41 +1,43 @@
-# Pagar.me módulo para WooCommerce #
-**Contributors:** [Pagar.me](https://profiles.wordpress.org/pagarme)
+![Pagar.me e WooCommerce logo](https://github.com/pagarme/woocommerce/blob/master/docs/images/pagarme+woocommerce-white.png#gh-dark-mode-only)
+![Pagar.me e WooCommerce logo](https://github.com/pagarme/woocommerce/blob/master/docs/images/pagarme+woocommerce.png#gh-light-mode-only)
+
+# Pagar.me módulo para WooCommerce
+
 **Tags:** ecommerce, e-commerce, store, sales, sell, shop, cart, checkout, woocommerce, pagarme, payments, creditcard
-**Requires at least:** 5.0
-**Tested up to:** 5.7
-**Stable tag:** 2.0.5
-**Requires PHP:** 7.1
+
 **License:** MIT
+
 **License URI:** https://github.com/pagarme/woocommerce/blob/master/LICENSE
 
-Módulo de integração da Pagar.me com o WooCommerce. Aceite pagamentos de cartão de crédito, boleto, multimeios e aumente a sua conversão.
+Módulo de integração da Pagar.me com o WooCommerce. Aceite pagamentos de cartão de crédito, pix, boleto, voucher e multimeios, e aumente a sua conversão.
 
-## Descrição ##
+## Descrição
 
 A inteligência do seu pagamento - Soluções focadas em aumentar sua conversão!
 
 Pagamentos tem que ser fáceis. São muitos passos por trás de uma simples transação financeira. Mas o seu consumidor não precisa saber disso. Nossas soluções estão disponíveis para ajuda-lo a aumentar sua conversão e oferecer a melhor experiência no momento do pagamento para o seu cliente.
 
-## Compatibilidade ##
+## Contribuição
+
+Se você está interessado em contribuir para o desenvolvimento deste projeto, ficamos felizes em receber sua ajuda! No [contributing.md](https://github.com/pagarme/woocommerce/blob/master/.github/contributing.md) está o guia de como contribuir com o projeto.
+
+## Compatibilidade
 
+- Requer Wordpress 4.1 ou posterior para funcionar.
 - Requer WooCommerce 3.9 ou posterior para funcionar.
 - Requer versão do PHP maior ou igual a 7.1.
 
-## Instalação do plugin: ##
+## Instalação do plugin
 
 - Envie os arquivos do plugin para a pasta wp-content/plugins, ou instale usando o instalador de plugins do WordPress.
 - Ative o plugin.
 
-## Requerimentos: ##
+## Requerimentos
 
-- [Conta na Pagar.me] (http://www.pagar.me/)
-- [WooCommerce] (https://wordpress.org/plugins/woocommerce/)
-- [WooCommerce Extra Checkout Fields for Brazil](https://wordpress.org/plugins/woocommerce-extra-checkout-fields-for-brazil/) em sua última versão
+- [Conta na Pagar.me](http://www.pagar.me/)
+- [WooCommerce](https://wordpress.org/plugins/woocommerce/)
 
-## Configurações ##
+## Contribuidores
 
-- Após a instalação e ativação do plugin acesse o menu WooCommerce > Configurações > Finalizar Compra > Pagar.me Pagamentos
-- Habilite o pagamento
-- Selecione o ambiente (Produção ou Sandbox)
-- Insira as chaves (pública e privada)
-- Em seguida selecione quais meios de pagamento deseja utilizar
+| ![eduardobattisti avatar](https://avatars.githubusercontent.com/u/56602897?s=60&v=4)<br/> [eduardobattisti](https://github.com/eduardobattisti) |
+|----------------------------------------------------------------------------------------------------------------------------------|