Add full recommended requirements to readme.txt #59794
Conversation
|
Waiting to get confirmation of our current minimum DB requirements as there is conflicting information p1752862458935469-slack-C03CPM3UXDJ |
Testing GuidelinesHi @kalessil , Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed. Reminder: PR reviewers are required to document testing performed. This includes:
|
📝 WalkthroughWalkthroughThe minimum requirements section in the WooCommerce readme file was updated to reflect a lower MySQL version requirement, a new minimum WordPress version, and recommendations for memory limit and HTTPS support. A reference to a detailed server requirements link was removed. Changes
Estimated code review effort1 (<30 minutes) Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
plugins/woocommerce/readme.txt (1)
145-149: Minor consistency nit – end punctuation.In the bullet list, only the last two bullets end with a period. Either finish all bullets with a period or remove them from the last two for stylistic consistency.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
plugins/woocommerce/readme.txt(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: jorgeatorres
PR: woocommerce/woocommerce#59675
File: .github/workflows/release-bump-as-requirement.yml:48-65
Timestamp: 2025-07-15T15:39:21.856Z
Learning: In WooCommerce core repository, changelog entries for all PRs live in `plugins/woocommerce/changelog/` directory and are processed during releases, not at the repository root level.
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.417Z
Learning: Provide clear, step-by-step instructions for how to test the changes in the PR description.
Learnt from: CR
PR: woocommerce/woocommerce#0
File: .cursor/rules/generate-pr-description.mdc:0-0
Timestamp: 2025-07-21T05:22:46.417Z
Learning: Applies to .github/PULL_REQUEST_TEMPLATE.md : Preserve required markdown sections in the PR description, especially those used by automation (e.g., changelog entry details and comments). Do not remove or alter them.
Learnt from: prettyboymp
PR: woocommerce/woocommerce#59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:60-83
Timestamp: 2025-06-26T12:45:40.709Z
Learning: WooCommerce uses WordPress versioning conventions where minor versions in X.Y.Z format are constrained to 0-9 (Y cannot exceed 9). This means version increment logic should reset minor to 0 and increment major when minor reaches 9, rather than allowing two-digit minor versions like 9.10 or 9.11.
Learnt from: vladolaru
PR: woocommerce/woocommerce#59486
File: plugins/woocommerce/src/Internal/Admin/Settings/PaymentsProviders/WooPayments/WooPaymentsService.php:1544-1544
Timestamp: 2025-07-08T11:18:07.871Z
Learning: WooCommerce has polyfills for newer PHP functions (like str_starts_with() from PHP 8.0+), so these functions can be safely used even though WooCommerce supports PHP 7.4+. No need to suggest PHP 7.4 compatible alternatives when polyfills are available.
Learnt from: opr
PR: woocommerce/woocommerce#0
File: :0-0
Timestamp: 2025-06-20T17:38:16.565Z
Learning: WooCommerce legacy JavaScript files in plugins/woocommerce/client/legacy/js/ must use older JavaScript syntax and cannot use modern features like optional chaining (?.) due to browser compatibility requirements. Explicit null checking with && operators should be used instead.
plugins/woocommerce/readme.txt (3)
Learnt from: vladolaru
PR: #59486
File: plugins/woocommerce/src/Internal/Admin/Settings/PaymentsProviders/WooPayments/WooPaymentsService.php:1544-1544
Timestamp: 2025-07-08T11:18:07.871Z
Learning: WooCommerce has polyfills for newer PHP functions (like str_starts_with() from PHP 8.0+), so these functions can be safely used even though WooCommerce supports PHP 7.4+. No need to suggest PHP 7.4 compatible alternatives when polyfills are available.
Learnt from: prettyboymp
PR: #59048
File: .github/workflows/cherry-pick-milestoned-prs.yml:60-83
Timestamp: 2025-06-26T12:45:40.709Z
Learning: WooCommerce uses WordPress versioning conventions where minor versions in X.Y.Z format are constrained to 0-9 (Y cannot exceed 9). This means version increment logic should reset minor to 0 and increment major when minor reaches 9, rather than allowing two-digit minor versions like 9.10 or 9.11.
Learnt from: opr
PR: woocommerce/woocommerce#0
File: :0-0
Timestamp: 2025-06-20T17:38:16.565Z
Learning: WooCommerce legacy JavaScript files in plugins/woocommerce/client/legacy/js/ must use older JavaScript syntax and cannot use modern features like optional chaining (?.) due to browser compatibility requirements. Explicit null checking with && operators should be used instead.
🔇 Additional comments (2)
plugins/woocommerce/readme.txt (2)
146-146: Re-check the downgraded MySQL minimum (5.5.5).WooCommerce’s own docs and most hosting providers currently recommend MySQL ≥ 5.6 or ≥ 5.7 for decent performance and full UTF-8/utf8mb4 support. Dropping the floor to 5.5.5 could be misleading and ‑ if adopted by users – surface subtle charset or index-length issues.
Please confirm with Core & Hosting teams before merging, or keep the existing 5.6+ requirement.
147-147: “WordPress 6.7 or greater” seems premature.6.7 is not yet released; setting it as the minimum blocks installs on all current production sites. Double-check if this was meant to be the recommended version instead, or if the correct floor is 6.4/6.5 (matching today’s core policy).
Based on discussions, we want to keep compatibility the same as WP core. |
* Add full recommended requirements to readme.txt * Set MySQL version at 5.5.5+
* Add full recommended requirements to readme.txt * Set MySQL version at 5.5.5+
Changes proposed in this Pull Request:
This extends the requirements listed in the readme.txt to include recommendations that are currently listed on https://woocommerce.com/document/server-requirements/.
To simplify the release process, we're going to be updating some of the pages currently on woocommece.com to just point to the requirements as listed on WordPress.org. This is the first step which is including the extra recommendation information. This expanded documentation will be the canonical information that shows up https://wordpress.org/plugins/woocommerce/#installation. Other documents will be updated to point to this.
Closes WOOPLUG-4966 / #59560 .
Changelog entry
Documentation only.
Changelog Entry Details
Significance
Type
Message
Changelog Entry Comment
Comment