Skip to content

Commit 16c1548

Browse files
Deep link contributing section into the handbook
The handbook is a better point of reference for contributors
1 parent 8689185 commit 16c1548

File tree

2 files changed

+9
-27
lines changed

2 files changed

+9
-27
lines changed

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ WP-CLI `packages/local/` directory.
6868

6969
### wp scaffold package-tests
7070

71-
Generate files needed for writing Behat tests for your command.
71+
Generate files for writing Behat tests for your command.
7272

7373
~~~
7474
wp scaffold package-tests <dir> [--ci=<provider>] [--force]
@@ -275,30 +275,21 @@ We appreciate you taking the initiative to contribute to this project.
275275

276276
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.
277277

278+
For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/).
279+
278280
### Reporting a bug
279281

280282
Think you’ve found a bug? We’d love for you to help us get it fixed.
281283

282284
Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/scaffold-package-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
283285

284-
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/scaffold-package-command/issues/new) with the following:
285-
286-
1. What you were doing (e.g. "When I run `wp post list`").
287-
2. What you saw (e.g. "I see a fatal about a class being undefined.").
288-
3. What you expected to see (e.g. "I expected to see the list of posts.")
289-
290-
Include as much detail as you can, and clear steps to reproduce if possible.
286+
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/scaffold-package-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).
291287

292288
### Creating a pull request
293289

294290
Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/scaffold-package-command/issues/new) to discuss whether the feature is a good fit for the project.
295291

296-
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
297-
298-
1. Create a feature branch for each contribution.
299-
2. Submit your pull request early for feedback.
300-
3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
301-
4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
292+
Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience.
302293

303294

304295
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

templates/readme-contributing.mustache

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,18 @@ We appreciate you taking the initiative to contribute to this project.
22

33
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.
44

5+
For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/).
6+
57
### Reporting a bug
68

79
Think you’ve found a bug? We’d love for you to help us get it fixed.
810

911
Before you create a new issue, you should [search existing issues](https://github.com/{{package_name}}/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
1012

11-
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/{{package_name}}/issues/new) with the following:
12-
13-
1. What you were doing (e.g. "When I run `wp post list`").
14-
2. What you saw (e.g. "I see a fatal about a class being undefined.").
15-
3. What you expected to see (e.g. "I expected to see the list of posts.")
16-
17-
Include as much detail as you can, and clear steps to reproduce if possible.
13+
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/{{package_name}}/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).
1814

1915
### Creating a pull request
2016

2117
Want to contribute a new feature? Please first [open a new issue](https://github.com/{{package_name}}/issues/new) to discuss whether the feature is a good fit for the project.
2218

23-
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
24-
25-
1. Create a feature branch for each contribution.
26-
2. Submit your pull request early for feedback.
27-
3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
28-
4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
19+
Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience.

0 commit comments

Comments
 (0)