Skip to content

docs: Clarify Git requirements. #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sun wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Clarify Git requirements. #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6187086
docs: Clarify Git requirements.
sun Jan 29, 2026
37b7677
fixup
sun Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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,
Expand All @@ -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
Expand Down