diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index c26b9540..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,46 +0,0 @@ -# Contributing - -First off, thanks for taking the time to contribute! - -### How can I contribute? - -* Fork this project; -* Make your changes / new implementatios; -* Use the pattern for git commts; -* Make sure that the acceptance criteria are met (tests, docs, etc); -* Create a pull request; - -### Pull Requests - -Template [PULLREQUEST-TEMPLATE](.github/PULLREQUEST-TEMPLATE.md) - -### Git Commit Messages - -* Use the present tense ("Adds feature" not "Added feature") -* Limit the first line to 72 characters or less -* Reference issues and pull requests liberally -* Consider starting the commit message with an applicable emoji: - * :art: `:art:` when improving the format/structure of the code - * :racehorse: `:racehorse:` when improving performance - * :non-potable_water: `:non-potable_water:` when plugging memory leaks - * :memo: `:memo:` when writing docs - * :penguin: `:penguin:` when fixing something on Linux - * :apple: `:apple:` when fixing something on Mac OS - * :checkered_flag: `:checkered_flag:` when fixing something on Windows - * :bug: `:bug:` when fixing a bug - * :fire: `:fire:` when removing code or files - * :green_heart: `:green_heart:` when fixing the CI build - * :white_check_mark: `:white_check_mark:` when adding tests - * :lock: `:lock:` when dealing with security - * :arrow_up: `:arrow_up:` when upgrading dependencies - * :arrow_down: `:arrow_down:` when downgrading dependencies - * :shirt: `:shirt:` when removing linter warnings - * :bulb: `:bulb:` new idea - * :construction: `:construction:` work in progress - * :heavy_plus_sign: `:heavy_plus_sign:` when adding features - * :heavy_minus_sign: `:heavy_minus_sign:` when removing features - * :speaker: `:mute:` when adding logging - * :mute: `:mute:` when reducing logging - * :facepunch: `:facepunch:` when resolve conflict - * :wrench: `:wrench:` when modify Web.config - diff --git a/.github/ISSUE-TEMPLATE.md b/.github/ISSUE-TEMPLATE.md deleted file mode 100644 index 69d1ee6b..00000000 --- a/.github/ISSUE-TEMPLATE.md +++ /dev/null @@ -1,43 +0,0 @@ -``` -Please use the following template to submit your issue. -Following this template will allow us to quickly investigate and help you with your issue. -Please be aware that issues which do not conform to this template may be closed. - -DO NOT FORGET TO REMOVE THIS BLOCK -``` - -### Status - -BUG REPORT / TASK - -### Checklist - -Add checklist if this is a task - -- [x] Add slack integration -- [_] Support xyz - -### Steps - -1. First step -2. Second step -3. Third step - -### Expected behaviour - -How do you think the program should work? Add screenshots and code blocks if necessary. - -### Actual behaviour - -How does the program work in its current state? - -### Environment - -You may write here the specifications like the version of the project, services, operating system, or hardware if applicable. - -### Logs / Stack trace - -``` -Insert your log/stack trace here -``` - diff --git a/.github/PULLREQUEST-TEMPLATE.md b/.github/PULLREQUEST-TEMPLATE.md deleted file mode 100644 index 956d4d30..00000000 --- a/.github/PULLREQUEST-TEMPLATE.md +++ /dev/null @@ -1,44 +0,0 @@ -``` -This is a guide to use this Pull Request Template. - -# Title -[feature] Implements the crazy powerful transaction search -[hotfix] Fixes login with e-mail address - -Add a gif that expresses your reaction to the implemented code, make it fun - -DO NOT FORGET TO REMOVE THIS BLOCK -``` -![Git Merge](https://media.giphy.com/media/cFkiFMDg3iFoI/giphy.gif) - -### Status - -READY / IN DEVELOPMENT - -### Whats? - -Describe in an objective way what has been done. - -### Why? - -Why do you need this implementation/fix? - -### How? - -How did you solve the problem? What are the main flows? Any technical information regarding infrastructure or architecture? - -### Attachments (if appropriate) - -Add additional informations like screenshots, issue link, zendesk ticket link, jira task link, etc - -### Definition of Done: -- [ ] Increases API documentation -- [ ] Implements integration tests -- [ ] Implements unit tests -- [ ] Is there appropriate logging included? -- [ ] Does this add new dependencies? -- [ ] Does need add new version in changelog? -- [ ] Does need update readme, contributing, etc? -- [ ] Does need change in CI server? -- [ ] Will this feature require a new piece of infrastructure be implemented? -- [ ] Does this PR require a blog post? If so, ensure marketing has signed off on content. diff --git a/.github/bug_report.md b/.github/bug_report.md new file mode 100644 index 00000000..0e03cc45 --- /dev/null +++ b/.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. + diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 00000000..8224937a --- /dev/null +++ b/.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 function to 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 diff --git a/.github/feature_request.md b/.github/feature_request.md new file mode 100644 index 00000000..0ee79355 --- /dev/null +++ b/.github/feature_request.md @@ -0,0 +1,4 @@ +# Nova funcionalidade + +### Descrição +Descreva detalhadamente a nova funcionalidade. diff --git a/.github/pull_request_template/branches/master.md b/.github/pull_request_template/branches/master.md new file mode 100644 index 00000000..404dbfd4 --- /dev/null +++ b/.github/pull_request_template/branches/master.md @@ -0,0 +1,8 @@ +## :sparkles: New Features +- + +## :bug: Bug fixes +- + +## :rocket: Improvements +- diff --git a/.github/pull_request_template/pull_request_template.md b/.github/pull_request_template/pull_request_template.md new file mode 100644 index 00000000..d6068cee --- /dev/null +++ b/.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. diff --git a/docs/README.md b/docs/README.md index 65b34c57..3678d58b 100644 --- a/docs/README.md +++ b/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 \ No newline at end of file +| ![eduardobattisti avatar](https://avatars.githubusercontent.com/u/56602897?s=60&v=4)
[eduardobattisti](https://github.com/eduardobattisti) | +|----------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/images/pagarme+woocommerce-white.png b/docs/images/pagarme+woocommerce-white.png new file mode 100644 index 00000000..c5e3d0f8 Binary files /dev/null and b/docs/images/pagarme+woocommerce-white.png differ diff --git a/docs/images/pagarme+woocommerce.png b/docs/images/pagarme+woocommerce.png new file mode 100644 index 00000000..1bdedd0b Binary files /dev/null and b/docs/images/pagarme+woocommerce.png differ