mirror of
https://github.com/woocommerce/woocommerce-paypal-payments.git
synced 2025-08-30 05:00:51 +08:00
Update GitHub templates
This commit is contained in:
Jorge A. Torres
parent
8cdcbcf4bb
commit
86f4eae14b
4 changed files with 108 additions and 75 deletions
40
.github/ISSUE_TEMPLATE.md
vendored
40
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
name: "Bug report"
|
||||
about: Report a bug if something isn't working as expected in WooCommerce PayPal Payments
|
||||
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
<!-- A clear and concise description of what the bug is. Please be as descriptive as possible; issues lacking detail, or for any other reason than to report a bug, may be closed without action.-->
|
||||
|
||||
### To reproduce
|
||||
<!-- Describe the steps to reproduce the behavior -->
|
||||
1.
|
||||
1.
|
||||
1.
|
||||
|
||||
**Screenshots**
|
||||
<!-- If applicable, add screenshots to help explain your problem.-->
|
||||
|
||||
### Expected behavior
|
||||
<!-- A clear and concise description of what you expected to happen.-->
|
||||
|
||||
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
- WordPress Version
|
||||
- WooCommerce Version
|
||||
- WooCommerce PayPal Payments Plugin Version
|
||||
- Browser [e.g. chrome, safari] and Version
|
||||
- Any other plugins installed
|
||||
|
||||
### Additional details
|
||||
<!--Here you can include any additional details you think might be helpful.-->
|
||||
<!--Ticket numbers/links, plugin versions, system statuses etc.-->
|
||||
<details><summary>System status</summary>
|
||||
|
||||
```
|
||||
<!--If applicable, paste the system status here. Please ensure you redact or remove any identifying information. -->
|
||||
```
|
||||
</details>
|
||||
|
||||
53
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
53
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Report a bug if something isn't working as expected
|
||||
labels: 'type: bug'
|
||||
|
||||
---
|
||||
|
||||
### Describe the Bug
|
||||
|
||||
<!-- A clear and concise description of what the bug is. Please be as descriptive as possible.-->
|
||||
|
||||
### To Reproduce
|
||||
|
||||
<!-- Describe the steps to reproduce the behavior -->
|
||||
1. Go to '…'
|
||||
2. Click on '…'
|
||||
3. Scroll down to …'
|
||||
4. See error
|
||||
|
||||
### Screenshots
|
||||
|
||||
<!-- If applicable, add screenshots to help explain your problem.-->
|
||||
|
||||
### Expected Behavior
|
||||
|
||||
<!-- A clear and concise description of what you expected to happen.-->
|
||||
|
||||
### Actual Behavior
|
||||
|
||||
<!-- A clear and concise description of what actually happens.-->
|
||||
|
||||
### Environment
|
||||
|
||||
<!-- Complete the following information about your environment. -->
|
||||
|
||||
- WordPress Version
|
||||
- WooCommerce Version
|
||||
- Plugin Version
|
||||
- Browser [e.g. Chrome, Safari] and Version
|
||||
- Any other plugins installed
|
||||
|
||||
### Additional Details
|
||||
|
||||
<!-- Include any additional details you think might be helpful. -->
|
||||
<!-- Ticket numbers/links, plugin versions, system statuses etc. -->
|
||||
|
||||
<details><summary>System status</summary>
|
||||
|
||||
```
|
||||
<!--If applicable, paste the system status here. Please ensure you redact or remove any identifying information. -->
|
||||
```
|
||||
|
||||
</details>
|
||||
29
.github/pull_request_template.md
vendored
29
.github/pull_request_template.md
vendored
|
|
@ -1,26 +1,35 @@
|
|||
<!-- Reference the source of this Pull Request. -->
|
||||
<!-- Remove any which are not applicable. -->
|
||||
<!-- Source of this Pull Request. Remove any that are not applicable. -->
|
||||
|
||||
**Issue**: #
|
||||
|
||||
**Ticket**:
|
||||
|
||||
**Slack Thread**:
|
||||
|
||||
---
|
||||
|
||||
### Description
|
||||
|
||||
<!-- Describe the changes made in this Pull Request and the reason for these changes. -->
|
||||
|
||||
### Steps to test:
|
||||
<!-- Describe the steps to replicate the issue and confirm the fix -->
|
||||
<!-- Try to include as many details as possible. -->
|
||||
1.
|
||||
1.
|
||||
1.
|
||||
### Steps to Test
|
||||
|
||||
<!-- Describe the steps to replicate the issue and confirm the fix. -->
|
||||
<!-- Include as many details as possible. -->
|
||||
|
||||
1. Go to '…'
|
||||
2. Click on '…'
|
||||
3. Scroll down to …'
|
||||
|
||||
### Documentation
|
||||
|
||||
<!-- Will this change require new documentation or changes to existing documentation? -->
|
||||
<!-- A good way to answer it is to ask: will more than one customer ever need to know about this? -->
|
||||
- [ ] This PR needs documentation (has the "Documentation" label).
|
||||
<!-- For an extra 💯 include further details about which change requires documentation -->
|
||||
<!-- For an extra 💯 include further details about which change requires documentation. -->
|
||||
|
||||
### Changelog Entry
|
||||
|
||||
### Changelog entry
|
||||
> Enter a summary of all changes on this Pull Request. This will appear in the changelog if accepted.
|
||||
|
||||
Closes # .
|
||||
|
|
|
|||
61
README.md
61
README.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
PayPal's latest complete payments processing solution. Accept PayPal, Pay Later, credit/debit cards, alternative digital wallets local payment types and bank accounts. Turn on only PayPal options or process a full suite of payment methods. Enable global transaction with extensive currency and country coverage.
|
||||
|
||||
## Requirements
|
||||
## Dependencies
|
||||
|
||||
* PHP >= 7.1
|
||||
* WordPress >=5.3
|
||||
|
|
@ -10,11 +10,12 @@ PayPal's latest complete payments processing solution. Accept PayPal, Pay Later,
|
|||
|
||||
## Development
|
||||
|
||||
1. Clone repository
|
||||
2. `$ cd woocommerce-paypal-payments`
|
||||
3. `$ composer install`
|
||||
4. `$ yarn run build:dev`
|
||||
5. Change the `PAYPAL_INTEGRATION_DATE` constant to `gmdate( 'Y-m-d' )` to run the latest PayPal JavaScript SDK
|
||||
### Install dependencies & build
|
||||
|
||||
- `$ composer install`
|
||||
- `$ yarn run build:dev`
|
||||
|
||||
Optionally, change the `PAYPAL_INTEGRATION_DATE` constant to `gmdate( 'Y-m-d' )` to run the latest PayPal JavaScript SDK
|
||||
|
||||
### Unit tests and code style
|
||||
|
||||
|
|
@ -23,9 +24,26 @@ PayPal's latest complete payments processing solution. Accept PayPal, Pay Later,
|
|||
3. `$ ./vendor/bin/phpcs`
|
||||
4. `$ ./vendor/bin/psalm`
|
||||
|
||||
### Docker
|
||||
### Building a release package
|
||||
|
||||
You can also use the Docker environment which includes WP, WC and all developments tools.
|
||||
If you want to build a release package
|
||||
(that can be used for deploying a new version on wordpress.org or manual installation on a WP website via ZIP uploading),
|
||||
follow these steps:
|
||||
|
||||
1. Clone the repository and `cd` into it.
|
||||
2. Make sure you have the version in the plugin root file updated.
|
||||
3. Update the PayPal JavaScript SDK integration date by using the current date for the `PAYPAL_INTEGRATION_DATE` constant.
|
||||
4. The following command should get you a ZIP file ready to be used on a WordPress site:
|
||||
|
||||
```
|
||||
$ yarn run build
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
You can install WooCommerce PayPal Payments locally using the dev environment of your preference, or you can use the Docker environment which includes WP, WC and all developments tools.
|
||||
|
||||
To set up the Docker environment, follow these steps:
|
||||
|
||||
0. Install Docker and Docker Compose.
|
||||
1. `$ cp .env.example .env` and edit the configuration in the `.env` file if needed.
|
||||
|
|
@ -34,8 +52,10 @@ You can also use the Docker environment which includes WP, WC and all developmen
|
|||
4. `$ yarn run docker:start`
|
||||
5. Add `127.0.0.1 wc-pp.myhost` to your `hosts` file and open http://wc-pp.myhost (the default value of `WP_DOMAIN` in `.env`).
|
||||
|
||||
### Running tests in the Docker environment
|
||||
|
||||
Tests and code style:
|
||||
- `$ yarn run docker:test`
|
||||
- `$ yarn run docker:test`
|
||||
- `$ yarn run docker:lint`
|
||||
|
||||
After some changes in `.env` (such as PHP, WP versions) you may need to rebuild the Docker image:
|
||||
|
|
@ -45,7 +65,13 @@ After some changes in `.env` (such as PHP, WP versions) you may need to rebuild
|
|||
|
||||
See [package.json](/package.json) for other useful commands.
|
||||
|
||||
### Webhooks
|
||||
## Test account setup
|
||||
|
||||
You will need a PayPal sandbox merchant and customer accounts to configure the plugin and make test purchases with it.
|
||||
|
||||
For setting up test accounts follow [these instructions](https://github.com/woocommerce/woocommerce-paypal-payments/wiki/Testing-Setup).
|
||||
|
||||
## Webhooks
|
||||
|
||||
For testing webhooks locally, follow these steps to set up ngrok:
|
||||
|
||||
|
|
@ -65,21 +91,6 @@ ngrok http -host-header=rewrite wc-pp.myhost
|
|||
Currently, ngrok is used only for the webhook listening URL.
|
||||
The URLs displayed on the WordPress pages, used in redirects, etc. will still remain local.
|
||||
|
||||
## Building a release package
|
||||
|
||||
If you want to build a release package
|
||||
(that can be used for deploying a new version on wordpress.org or manual installation on a WP website via ZIP uploading),
|
||||
follow these steps:
|
||||
|
||||
1. Clone the repository and `cd` into it.
|
||||
2. Make sure you have the version in the plugin root file updated.
|
||||
3. Update the PayPal JavaScript SDK integration date by using the current date for the `PAYPAL_INTEGRATION_DATE` constant.
|
||||
4. The following command should get you a ZIP file ready to be used on a WordPress site:
|
||||
|
||||
```
|
||||
$ yarn run build
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[GPL-2.0 License](LICENSE)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue
