You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit e4b8b85
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: contributions/committers-credo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Practically-speaking:
20
20
21
21
## Stellar judgement
22
22
23
-
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement with making decisions on new features, fixing bugs, merging others pull requests, and generally working on the project.
23
+
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement when making decisions on new features, fixing bugs, merging others' pull requests, and generally working on the project.
Copy file name to clipboardExpand all lines: contributions/pull-requests.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ If you haven't submitted a pull request before, you'll want to install WP-CLI fo
62
62
4. Install all Composer dependencies: `composer install`
63
63
5. Verify WP-CLI was installed properly: `vendor/bin/wp --info`
64
64
65
-
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus getting an unexpected result.
65
+
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus get an unexpected result.
66
66
67
67
### Working on the project as a whole
68
68
@@ -192,7 +192,7 @@ To run the unit tests, execute:
Copy file name to clipboardExpand all lines: contributions/release-checklist.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# Release Checklist
2
2
3
-
There are two different release checklists available from within the [`
4
-
wp-cli/wp-cli`
5
-
](https://github.com/wp-cli/wp-cli) repository:
3
+
There are two different release checklists available from within the [`wp-cli/wp-cli`](https://github.com/wp-cli/wp-cli) repository:
6
4
7
5
* Generate a [🚀 Regular Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=4-REGULAR_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to major (2.x.x) and minor (x.1.x) releases.
8
6
* Generate a [🔧 Patch Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=5-PATCH_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to patch (x.x.1) releases only.
Copy file name to clipboardExpand all lines: contributions/repository-management.md
+8-14Lines changed: 8 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,9 +40,13 @@ Labels can be part of a label group, a concept that is applicable to all package
40
40
41
41
#### Command
42
42
43
-
The labels that define what exact command a given issue/pull request applies to are prefixed with `command:`
43
+
The labels that define what specific command a given issue/pull request is related to are prefixed with `command:`.
44
44
45
-
_Example: `command:cli-update`_
45
+
Some examples:
46
+
47
+
*`command:core` - Relates to one or more of the subcommands under the `wp core` parent command.
48
+
*`command:cli-check-update` - Relates to the `wp cli check-update` command.
49
+
*`command:post-meta-update` - Relates to the `wp post meta update` command.
46
50
47
51
#### Scope
48
52
@@ -59,23 +63,13 @@ Used scopes:
59
63
60
64
#### State
61
65
62
-
The labels that defined what state a given issue/pull request is in are prefixed with `state:`.
66
+
The labels that define what state a given issue/pull request is in are prefixed with `state:`.
63
67
64
68
Used states:
65
69
66
70
*`state:unconfirmed` - The bug/problem in the issue could not be replicated yet or might be related to the reporter's environment.
67
71
*`state:unsupported` - The issue is outside of the scope of a bug report and cannot be supported on GitHub. The reporter should be pointed towards one of the [support channels](https://make.wordpress.org/cli/handbook/support/).
68
72
69
-
#### Command
70
-
71
-
The labels that define what specific command a given issue/pull request is related to are prefixed with `command:`.
72
-
73
-
Some examples:
74
-
75
-
*`command:core` - Relates to one or more of the subcommands under the `wp core` parent command.
76
-
*`command:cli-check-update` - Relates to the `wp cli check-update` command.
77
-
*`command:post-meta-update` - Relates to the `wp post-meta update` command.
78
-
79
73
### Required Labels
80
74
81
75
Some labels have a special meaning and/or might be used for automated workflows down the road. These are required across all official packages.
@@ -98,7 +92,7 @@ Good first issues are small in scope and don't require extensive technical exper
98
92
99
93
## Commits
100
94
101
-
No direct commits are to be done against the default branch (`main`/`master`) branch of the packages. All code changes need to go through a pull request workflow.
95
+
No direct commits are to be done against the default (`main`/`master`) branch of the packages. All code changes need to go through a pull request workflow.
Copy file name to clipboardExpand all lines: contributions/security-vulnerability-reporting.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ This includes weaknesses where the fix would:
75
75
- Remove or restrict a documented feature
76
76
- Impose significant complexity in order to fix a vulnerability that requires implausible preconditions
77
77
78
-
Such fixes may do more harm than the issue it addresses. Where the downside of fixing such an issue exceeds the vulnerability's impact, the team may instead choose to clearly document the behavior.
78
+
Such fixes may do more harm than the issue they address. Where the downside of fixing such an issue exceeds the vulnerability's impact, the team may instead choose to clearly document the behavior.
Copy file name to clipboardExpand all lines: guides.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
***[Common issues and their fixes](https://make.wordpress.org/cli/handbook/guides/common-issues/)** - In case of fire, break glass.
9
9
***[External resources](https://make.wordpress.org/cli/handbook/guides/external-resources/)** - Blog posts, slides and videos from users.
10
10
***[Force output to a specific locale](https://make.wordpress.org/cli/handbook/guides/force-output-specific-locale/)** - Localisation issue
11
-
***[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advise
11
+
***[Identify a Plugin or Theme Conflict](https://make.wordpress.org/cli/handbook/guides/identify-plugin-theme-conflict/)** - Debugging advice
12
12
***[Installing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/installing-packages/)** - Learn how to install packages and use version constraints
13
13
***[Sharing WP-CLI Packages](https://make.wordpress.org/cli/handbook/guides/sharing-wp-cli-packages/)** - Some words about your environment
14
14
***[Troubleshooting Guide](https://make.wordpress.org/cli/handbook/guides/troubleshooting/)** - Some help to troubleshoot
Copy file name to clipboardExpand all lines: guides/commands-cookbook.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Packages are to WP-CLI as plugins are to WordPress. There are distinct differenc
16
16
17
17
Bundled commands:
18
18
19
-
* Usually cover functionality offered by a standard install WordPress. There are exceptions to this rule though, notably `wp search-replace` ([doc](https://developer.wordpress.org/cli/commands/search-replace/)).
19
+
* Usually cover functionality offered by a standard WordPress installation. There are exceptions to this rule though, notably `wp search-replace` ([doc](https://developer.wordpress.org/cli/commands/search-replace/)).
20
20
* Do not depend on other components such as plugins, themes etc.
@@ -284,7 +284,7 @@ The `---` block after a parameter description allows you to set extra metadata f
284
284
The longdesc is also displayed when calling the `help` command, for example, `wp help example hello`. Its syntax is [Markdown Extra](http://michelf.ca/projects/php-markdown/extra/) and here are a few more notes on how it's handled by WP-CLI:
285
285
286
286
* The longdesc is generally treated as a free-form text. The `OPTIONS` and `EXAMPLES` section names are not enforced, just common and recommended.
287
-
*Sections names (`## NAME`) are colorized and printed with zero indentation.
287
+
*Section names (`## NAME`) are colorized and printed with zero indentation.
288
288
* Everything else is indented by 2 characters, option descriptions are further indented by additional 2 characters.
289
289
* Word-wrapping is a bit tricky. If you want to utilize as much space on each line as possible and don't get word-wrapping artifacts like one or two words on the next line, follow these rules:
290
290
* Hard-wrap option descriptions at **75 chars** after the colon and a space.
@@ -437,7 +437,7 @@ function hello( $args, $assoc_args ) {
437
437
}
438
438
```
439
439
440
-
`$args` variable will store all the positional arguments:
440
+
The `$args` variable will store all the positional arguments:
441
441
442
442
```
443
443
$ wp example hello Joe Doe
@@ -448,7 +448,7 @@ WP_CLI::line( $args[0] ); // Joe
448
448
WP_CLI::line( $args[1] ); // Doe
449
449
```
450
450
451
-
`$assoc_args` variable will store all the arguments defined like `--key=value` or `--flag` or `--no-flag`
451
+
The `$assoc_args` variable will store all the arguments defined like `--key=value` or `--flag` or `--no-flag`:
452
452
453
453
```
454
454
$ wp example hello --name='Joe Doe' --verbose --no-option
@@ -626,7 +626,7 @@ Both approaches are valid. Use the `WP_CLI` constant check when you need to cond
626
626
627
627
### Distribute as a stand-alone command
628
628
629
-
Standalone WP-CLI commands can be installed from any git repository, ZIP file or folder. The only technical requirement is to include a valid composer.json file with an autoload declaration. We recommended including `"type": "wp-cli-package"` to distinguish your project explicitly as a WP-CLI package.
629
+
Standalone WP-CLI commands can be installed from any git repository, ZIP file or folder. The only technical requirement is to include a valid composer.json file with an autoload declaration. We recommend including `"type": "wp-cli-package"` to distinguish your project explicitly as a WP-CLI package.
630
630
631
631
Here's a full composer.json example from the server command:
632
632
@@ -656,7 +656,7 @@ Here's a full composer.json example from the server command:
656
656
657
657
Note the `autoload` declaration, which loads `command.php`.
658
658
659
-
Once you've added a valid composer.json file to your project repository, WP-CLI users can pull it in via the package manager from the location you opted to store it in. Here's a few examples of storage locations and the corresponding syntax of installing it via the package manager:
659
+
Once you've added a valid composer.json file to your project repository, WP-CLI users can pull it in via the package manager from the location you opted to store it in. Here are a few examples of storage locations and the corresponding syntax of installing it via the package manager:
Copy file name to clipboardExpand all lines: guides/running-commands-remotely.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -166,8 +166,8 @@ Another way to achieve this is to specify the `$PATH` in the remote machine user
166
166
167
167
### Remote non-interactive shell resolves aliases and runs wp as alias with php
168
168
169
-
Some webhosts are configured very restrictive:
170
-
- They do not allow you to execute your own shellscripts, so everything from method [WP-CLI binary](#copy-wp-cli-binary-to-home-bin) fails.
169
+
Some web hosts are configured very restrictively:
170
+
- They do not allow you to execute your own shell scripts, so everything from method [WP-CLI binary](#copy-wp-cli-binary-to-home-bin) fails.
171
171
- `sshd` is configured with `PermitUserEnvironment=no`, so customizing [~/.ssh/environment](#specify-the-path-in-home-ssh-environment) has no effect and fails too.
172
172
- Also [using the before_ssh hook on the client machine](#using-before_ssh-hook-on-client-machine) will not help you, as in all cases you cannot run `wp` on the remote.
0 commit comments