Add a contributing page based on CONTRIBUTING.md

danielbachhuber · danielbachhuber · commit fa6d43d8d3ff · 2016-07-01T15:55:32.000-07:00
diff --git a/_includes/doc-list.html b/_includes/doc-list.html
@@ -34,6 +34,7 @@ <h3 id="contributing">Contributing</h3>
 <h3 id="misc">Misc</h3>
 
 <ul>
+<li><a href="/docs/contributing/"><strong>Contributing</strong></a></li>
 <li><a href="/docs/plugin-unit-tests/"><strong>Plugin unit tests</strong></a> - How to set up and run PHPUnit tests for a WordPress plugin.</li>
 </ul>
 
diff --git a/command.php b/command.php
@@ -44,6 +44,44 @@ function generate_homepage() {
 }
 WP_CLI::add_command( 'website generate-homepage', '\WP_CLI_Org\generate_homepage' );
 
+/**
+ * Generate the contributing page from the repo's CONTRIBUTING.md
+ *
+ * @when before_wp_load
+ */
+function generate_contributing() {
+	$ret = trim( shell_exec( 'which wp' ) );
+	if ( empty( $ret ) ) {
+		WP_CLI::error( 'Could not find path to wp executable.' );
+	}
+	if ( 'link' === filetype( $ret ) ) {
+		$ret = readlink( $ret );
+	}
+
+	$contributing_path = dirname( dirname( $ret ) ) . '/CONTRIBUTING.md';
+	if ( ! is_file( $contributing_path ) ) {
+		WP_CLI::error( 'Could not find CONTRIBUTING.md in wp executable PATH. Please make sure wp executable points to git clone.' );
+	}
+
+	$contents = file_get_contents( $contributing_path );
+	$search = <<<EOT
+Contributing
+============
+EOT;
+	$replace = <<<EOT
+---
+layout: default
+title: Contributing
+category: Contributing
+description: An introduction to the contributing process.
+---
+EOT;
+	$contents = str_replace( $search, $replace, $contents );
+	file_put_contents( dirname( __FILE__ ) . '/docs/contributing/index.md', $contents );
+	WP_CLI::success( 'Updated docs/contributing/index.md from project CONTRIBUTING.md.' );
+}
+WP_CLI::add_command( 'website generate-contributing', '\WP_CLI_Org\generate_contributing' );
+
 /**
  * Dump the list of internal APIs, as JSON.
  *
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -0,0 +1,32 @@
+---
+layout: default
+title: Contributing
+---
+
+Welcome and thanks!
+
+We appreciate you taking the initiative to contribute to WP-CLI. It’s because of you, and the community around you, that WP-CLI is such a great 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.
+
+Please take a moment to read these guidelines at depth. Following the guidelines helps to communicate that you respect the time of the other contributors to the project. In turn, they’ll do their best to reciprocate that respect when working with you, across timezones and around the world.
+
+### Reporting a bug
+
+Think you’ve found a bug? We’d love for you to help us get it fixed.
+
+Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/wp-cli/issues?utf8=%E2%9C%93&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 of WP-CLI. You should also check our [documentation on common issues and their fixes](https://wp-cli.org/docs/common-issues/).
+
+Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [follow our guidelines for submitting a bug report](http://wp-cli.org/docs/bug-reports/) to make sure it gets addressed in a timely manner.
+
+### Creating a pull request
+
+Want to contribute a new feature? WP-CLI is a mature project, and already chock-full of useful functionality. Please first [open a new issue](https://github.com/wp-cli/wp-cli/issues/new) to discuss whether the feature is a good fit for WP-CLI core, or might be better suited as a [community package](https://wp-cli.org/package-index/).
+
+Once you've decided to commit the time to seeing your pull request through, please [follow our guidelines for creating a pull request](https://wp-cli.org/docs/pull-requests/) to make sure it's a pleasant experience.
+
+### Contributing in other ways
+
+Feel free to [create an issue](https://github.com/wp-cli/wp-cli/issues/new) with your question, and we'll see if we can find an answer for it.
+
+Alternatively, if you have a WordPress.org account, you may also consider joining the `#cli` channel on the [WordPress.org Slack organization](https://make.wordpress.org/chat/).
diff --git a/index.md b/index.md
@@ -105,19 +105,29 @@ WP-CLI's maintainers and project contributors do their best to respond to all ne
 - [Open or closed issues on Github](https://github.com/wp-cli/wp-cli/issues?utf8=%E2%9C%93&q=is%3Aissue)
 - [WordPress StackExchange forums](http://wordpress.stackexchange.com/questions/tagged/wp-cli)
 
+If you can't find your answer in one of those existing resources, feel free to [create an issue](https://github.com/wp-cli/wp-cli/issues/new) with your question.
+
 If you have a WordPress.org account, you may also consider joining the `#cli` channel on the [WordPress.org Slack organization](https://make.wordpress.org/chat/).
 
 ## Extending
 
 A **command** is an atomic unit of WP-CLI functionality. `wp plugin install` ([doc](https://wp-cli.org/commands/plugin/install/)) is one command. `wp plugin activate` ([doc](https://wp-cli.org/commands/plugin/activate/)) is another.
 
-WP-CLI comes with dozens of commands. It's easier than it looks to create a custom WP-CLI command. Read the [commands cookbook](https://wp-cli.org/docs/commands-cookbook/) to learn more. Browse the [internal API docs](http://wp-cli.org/docs/internal-api/) to discover a variety of helpful functions you can use in your custom WP-CLI command.
+WP-CLI comes with dozens of commands. It's easier than it looks to create a custom WP-CLI command. Read the [commands cookbook](https://wp-cli.org/docs/commands-cookbook/) to learn more. Browse the [internal API docs](https://wp-cli.org/docs/internal-api/) to discover a variety of helpful functions you can use in your custom WP-CLI command.
 
 ## Contributing
 
-To get involved, please first read about [creating an issue](https://wp-cli.org/docs/bug-reports/) or [submitting a pull request](https://wp-cli.org/docs/pull-requests/).
+Welcome and thanks!
+
+We appreciate you taking the initiative to contribute to WP-CLI. It’s because of you, and the community around you, that WP-CLI is such a great 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.
+
+Please take a moment to [read these guidelines at depth](https://wp-cli.org/docs/contributing/). Following them helps to communicate that you respect the time of the other contributors to the project. In turn, they’ll do their best to reciprocate that respect when working with you, across timezones and around the world.
+
+## Leadership
 
-### Leadership
+WP-CLI is led by these individuals:
 
 * [Daniel Bachhuber](https://github.com/danielbachhuber/) - current maintainer
 * [Cristi Burcă](https://github.com/scribu) - previous maintainer
