Skip to content
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

Jump to bottom

Fix typos and update docs #59

Merged
merged 1 commit into from
Mar 19, 2024
Merged

Fix typos and update docs #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .readme-partials/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to make code changes to WP-CLI, you'll need to set up this `wp-cli-dev`

Before you can proceed further, you'll need to make sure you have [Composer](https://getcomposer.org/), PHP, and a functioning MySQL or MariaDB server on your local machine.

Once the prequisites are met, clone the GitHub repository and run the installation process:
Once the prerequisites are met, clone the GitHub repository and run the installation process:

```bash
git clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev
Expand Down
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In order to make code changes to WP-CLI, you'll need to set up this `wp-cli-dev`

Before you can proceed further, you'll need to make sure you have [Composer](https://getcomposer.org/), PHP, and a functioning MySQL or MariaDB server on your local machine.

Once the prequisites are met, clone the GitHub repository and run the installation process:
Once the prerequisites are met, clone the GitHub repository and run the installation process:

```bash
git clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev
Expand Down Expand Up @@ -64,13 +64,22 @@ wp maintenance
Lists all contributors to this release.

~~~
wp maintenance contrib-list [--format=<format>]
wp maintenance contrib-list [<repo>] [<milestone>...] [--format=<format>]
~~~

Run within the main WP-CLI project repository.

**OPTIONS**

[<repo>]
Name of the repository to fetch the release notes for. If no user/org
was provided, 'wp-cli' org is assumed. If no repo is passed, release
notes for the entire org state since the last bundle release are fetched.

[<milestone>...]
Name of one or more milestones to fetch the release notes for. If none
are passed, the current open one is assumed.

[--format=<format>]
Render output in a specific format.
---
Expand Down Expand Up @@ -156,7 +165,7 @@ wp maintenance release-notes [<repo>] [<milestone>...] [--source=<source>] [--fo

[<milestone>...]
Name of one or more milestones to fetch the release notes for. If none
are passed, the currently open one is assumed.
are passed, the current open one is assumed.

[--source=<source>]
Choose source from where to copy content.
Expand Down Expand Up @@ -207,7 +216,7 @@ We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policies and guidelines.
For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.

### Reporting a bug

Expand All @@ -225,6 +234,6 @@ Once you've decided to commit the time to seeing your pull request through, [ple

## Support

Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support