Skip to content

Commit dd5addc

Browse files
authored
Adding a README.md file with dev-focused instructions (#4031)
* Adding a README.md file with dev-focused instructions * Doc for version support policy * Fix repository address * Readme and changelog entries * Fix version support policy typo * Capitalizing titles and tool names * Replacing functions with functionatilies
1 parent 89837d4 commit dd5addc

File tree

4 files changed

+48
-0
lines changed

4 files changed

+48
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# WooCommerce Stripe Payment Gateway
2+
3+
This is the official feature plugin for accepting payments via the Stripe payment gateway on a WooCommerce store.
4+
5+
## Dependencies
6+
7+
- WooCommerce
8+
9+
## Version Support Policy
10+
11+
We adopt the L-2 version support policy for WordPress core strictly, and a loose L-2 policy for WooCommerce. See [more details](./docs/version-support-policy.md).
12+
13+
## Development
14+
15+
### Install Dependencies & Build
16+
17+
- `npm install`
18+
- `composer install`
19+
- `npm run build:webpack`, or if you're developing the client you can have it auto-update when changes are made: `npm start`
20+
21+
If you run into errors with `npm install` it may be due to node version, try `nvm install` followed by `nvm use` then try again.
22+
23+
When running the `composer install/update`, Composer may prompt you for a GitHub OAuth token before it can fetch the `subscriptions` and `pre-orders` extensions from GitHub.
24+
25+
## Setup
26+
27+
If you're using the Docker environment see setup instructions here:
28+
https://github.com/woocommerce/woocommerce-gateway-stripe/blob/trunk/docs/DOCKER.md
29+
30+
Install the following plugins:
31+
32+
- WooCommerce
33+
- Stripe Dev Tools (clone or download [the GitHub repo](https://github.com/woocommerce/woocommerce-gateway-stripe-dev-tools))
34+
35+
## Debugging
36+
37+
If you are following the Docker setup [here](https://github.com/woocommerce/woocommerce-gateway-stripe/blob/trunk/docs/DOCKER.md), Xdebug is ready to use for debugging.
38+
39+
Install [Xdebug Helper browser extension mentioned here](https://xdebug.org/docs/remote) to enable Xdebug on demand.

changelog.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*** Changelog ***
22

33
= 9.3.0 - xxxx-xx-xx =
4+
* Dev - Adds a new README.md file to the plugin with specific development-focused instructions.
45
* Add - Implements the Single Payment Element feature for the new checkout experience on the block checkout page.
56
* Dev - Additional replacements for payment method constant values on the backend.
67
* Fix - Improves the checking for existing customer attribute when retrieving a payment method that may be detached from a subscription.

docs/version-support-policy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Version Support Policy
2+
3+
We have officially announced the L-2 version support policy for WooCommerce and WordPress core [since May 2021](https://developer.woocommerce.com/2021/05/12/woocommerce-payments-is-adopting-a-new-version-support-policy/).
4+
5+
## What does this policy mean for contributors?
6+
7+
As a contributor to WooCommerce Stripe Payment Gateway, you should be mindful when adding new features and functionalities to your PRs as your code needs to work within proper ranges of WordPress and WooCommerce versions. Although we have [a CI workflow](https://github.com/woocommerce/woocommerce-gateway-stripe/blob/develop/.github/workflows/compatibility.yml) to check the compatibility between the Stripe extension and these ranges, it's still good for contributors to be aware of this policy.

readme.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
111111
== Changelog ==
112112

113113
= 9.3.0 - xxxx-xx-xx =
114+
* Dev - Adds a new README.md file to the plugin with specific development-focused instructions.
114115
* Add - Implements the Single Payment Element feature for the new checkout experience on the block checkout page.
115116
* Dev - Additional replacements for payment method constant values on the backend.
116117
* Fix - Improves the checking for existing customer attribute when retrieving a payment method that may be detached from a subscription.

0 commit comments

Comments
 (0)