Merge pull request #128 from wp-cli/125-contributing-file

Add a basic CONTRIBUTING.md to point to contrib guidelines

Author: gitlost

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+Contributing
+============
+
+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 policy and guidelines.

features/scaffold-package.feature

@@ -38,6 +38,11 @@ Feature: Scaffold WP-CLI commands
           },
       """
     And the {PACKAGE_PATH}/local/wp-cli/foo/command.php file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/CONTRIBUTING.md file should exist
+    And the {PACKAGE_PATH}/local/wp-cli/foo/CONTRIBUTING.md file should contain:
+      """
+      Contributing
+      """
     And the {PACKAGE_PATH}/local/wp-cli/foo/wp-cli.yml file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/.travis.yml file should not exist
 
@@ -139,6 +144,7 @@ Feature: Scaffold WP-CLI commands
       s
       s
       s
+      s
       """
 
     When I run `wp scaffold package wp-cli/same-package --skip-tests`

src/ScaffoldPackageCommand.php

@@ -96,6 +96,7 @@ public function package( $args, $assoc_args ) {
 			"{$package_dir}/.gitignore"     => file_get_contents( "{$package_root}/.gitignore" ),
 			"{$package_dir}/.editorconfig"  => file_get_contents( "{$package_root}/.editorconfig" ),
 			"{$package_dir}/.distignore"    => file_get_contents( "{$package_root}/.distignore" ),
+			"{$package_dir}/CONTRIBUTING.md"=> file_get_contents( "{$package_root}/CONTRIBUTING.md" ),
 			"{$package_dir}/wp-cli.yml"     => $wp_cli_yml,
 			"{$package_dir}/command.php"    => Utils\mustache_render( "{$template_path}/command.mustache", $assoc_args ),
 			"{$package_dir}/composer.json"  => Utils\mustache_render( "{$template_path}/composer.mustache", $assoc_args ),

templates/readme-contributing.mustache

@@ -2,7 +2,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