Merge pull request #130 from miya0001/add-support-policy-to-readme

Add support policy to readme

Author: danielbachhuber

README.md

@@ -5,7 +5,7 @@ Scaffold WP-CLI commands with functional tests
 
 [![Build Status](https://travis-ci.org/wp-cli/scaffold-package-command.svg?branch=master)](https://travis-ci.org/wp-cli/scaffold-package-command) [![CircleCI](https://circleci.com/gh/wp-cli/scaffold-package-command/tree/master.svg?style=svg)](https://circleci.com/gh/wp-cli/scaffold-package-command/tree/master)
 
-Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
+Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)
 
 ## Using
 
@@ -144,7 +144,7 @@ WP-CLI Behat framework uses Behat ~2.5, which is installed with Composer.
 **OPTIONS**
 
 	<dir>
-		The package directory to generate tests for.
+		Directory path to an existing package to generate tests for.
 
 	[--ci=<provider>]
 		Create a configuration file for a specific CI provider.
@@ -232,7 +232,7 @@ In this example:
 **OPTIONS**
 
 	<dir>
-		Directory of an existing command.
+		Directory path to an existing package to generate a readme for.
 
 	[--force]
 		Overwrite the readme if it already exists.
@@ -256,7 +256,7 @@ files include:
 **OPTIONS**
 
 	<dir>
-		The package directory to generate GitHub configuration for.
+		Directory path to an existing package to generate GitHub configuration for.
 
 	[--force]
 		Overwrite files that already exist.
@@ -275,7 +275,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/).
+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
 
@@ -291,5 +291,9 @@ Want to contribute a new feature? Please first [open a new issue](https://github
 
 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.
 
+## Support
+
+Github issues aren't for general support questions, but there are other venues you can try: http://wp-cli.org/#support
+
 
 *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.*

src/ScaffoldPackageCommand.php

@@ -298,6 +298,7 @@ public function package_readme( $args, $assoc_args ) {
 				'Using',
 				'Installing',
 				'Contributing',
+				'Support',
 			);
 		}
 
@@ -309,7 +310,7 @@ public function package_readme( $args, $assoc_args ) {
 			);
 		}
 		$bundled = ! empty( $composer_obj['extra']['bundled'] );
-		foreach( array( 'using', 'installing', 'contributing' ) as $key ) {
+		foreach( array( 'using', 'installing', 'contributing', 'support' ) as $key ) {
 			if ( isset( $readme_sections[ $key ] ) ) {
 				$file = dirname( dirname( __FILE__ ) ) . '/templates/readme-' . $key . '.mustache';
 				if ( $bundled

templates/readme-support.mustache

@@ -0,0 +1 @@
+Github issues aren't for general support questions, but there are other venues you can try: http://wp-cli.org/#support