From 618708681d3f5fe40fc82f6e37166bd53648f17e Mon Sep 17 00:00:00 2001 From: Daniel Kudwien Date: Thu, 29 Jan 2026 17:33:48 +0100 Subject: [PATCH 1/2] docs: Clarify Git requirements. --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a49b00e..b7f5f97 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,13 @@ chapter. ## Installation +### Requirements + +* Git command line +* All code of plugins is under Git version control. +* PHP 7.4 or later + + ### Install as WP-CLI package (user-specific) 1. Ensure you have [WP-CLI](http://wp-cli.org/) installed and set up in your `$PATH`. @@ -86,11 +93,6 @@ chapter. ``` -### Requirements - -* PHP 7.4 or later. - - ## Creating patches All patches are created from an existing commit, so that the author, committer, @@ -101,18 +103,21 @@ your changes into a single commit if you have multiple commits. Each patch filename must be in the following structure, delimited by dots: +``` +example-plugin.0001.fix.relevant-context-keywords.patch +``` 1. Name of the plugin (folder). -2. Patch number, starting from `0000`. Automatically generated. +2. Patch number, starting from `0000` (automatically generated). 3. Type of change, either `"fix"` or `"feature"`. 4. Keywords to provide approximate context, delimited by hyphens. +The following command will create a new patch file in the [`/patches`](patches) folder, which you +can then add to the repository: + ```console $ wp patch create example-plugin c03314 fix keywords-context-info ``` -This will create a new patch file in the [`/patches`](patches) folder, which you -can then add to the repository. - Here is how the comand works under the hood: ```console From 37b767722220b1a95efe69c61008addd64ba333b Mon Sep 17 00:00:00 2001 From: Daniel Kudwien Date: Thu, 29 Jan 2026 17:35:06 +0100 Subject: [PATCH 2/2] fixup --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b7f5f97..ffef2dd 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ chapter. ### Requirements * Git command line -* All code of plugins is under Git version control. +* All code of plugins is under Git version control * PHP 7.4 or later @@ -111,8 +111,8 @@ example-plugin.0001.fix.relevant-context-keywords.patch 3. Type of change, either `"fix"` or `"feature"`. 4. Keywords to provide approximate context, delimited by hyphens. -The following command will create a new patch file in the [`/patches`](patches) folder, which you -can then add to the repository: +The following command will create a new patch file in the [`/patches`](patches) +folder, which you can then add to the repository: ```console $ wp patch create example-plugin c03314 fix keywords-context-info