Skip to content

Commit 6f5ed71

Browse files
authored
Merge pull request #52 from woocommerce/24-12/update/validation-readme-license
Add readme.txt and License header info
2 parents 8095287 + 924ca81 commit 6f5ed71

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/managed-tests/validation.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@ Validation tests ensure that your extension’s metadata and WooCommerce feature
44

55
## What validation tests check
66

7+
- **readme.txt file:**
8+
The test checks for the presence of a readme.txt file, which all plugins and themes are [required to provide](https://woocommerce.com/document/create-a-plugin/#section-8).
9+
710
- **Plugin headers:**
811
The test checks for the presence of important headers in your plugin or theme’s main file and `readme.txt`. The following headers should be present and accurate:
912
- `Requires PHP`
1013
- `Requires at least`
1114
- `Tested up to`
1215
- `WC requires at least`
1316
- `WC tested up to`
17+
- `License`
1418

1519
Missing or incorrect versions will trigger a warning. Additionally, certain headers should **not** be included:
1620
- `Woo` — As noted in the [WooCommerce plugin creation documentation](https://woocommerce.com/document/create-a-plugin/#section-14), this will be automatically added during deployment. Including it manually may cause issues and will be warned against.
@@ -30,15 +34,18 @@ Validation tests ensure that your extension’s metadata and WooCommerce feature
3034
## Possible outcomes
3135

3236
- **Success:**
33-
All required metadata is present and correct, and no invalid headers or incompatible feature declarations were found.
37+
A readme.txt file is present, all required metadata is present and correct, and no invalid headers or incompatible feature declarations were found.
3438

3539
- **Warning:**
36-
Some headers may be missing or incorrect, or you declared incompatibility with WooCommerce features that you should ideally support. If you’re a theme developer, outdated templates are flagged as warnings and should be updated.
40+
A readme.txt file may be missing or misnamed, some headers may be missing or incorrect, or you declared incompatibility with WooCommerce features that you should ideally support. If you’re a theme developer, outdated templates are flagged as warnings and should be updated.
3741

3842
## Interpreting results
3943

4044
If you receive warnings:
4145

46+
- **Check your readme.txt file:**
47+
Ensure a correctly named readme.txt file is provided in the root directory of your plugin or theme.
48+
4249
- **Review headers and declarations:**
4350
Ensure all required headers are accurate and that you’re not declaring incompatibility with features you could support.
4451

0 commit comments

Comments
 (0)