diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fa86aa5 --- /dev/null +++ b/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. diff --git a/features/scaffold-package.feature b/features/scaffold-package.feature index 9cc30c0..821ab1b 100644 --- a/features/scaffold-package.feature +++ b/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 diff --git a/src/ScaffoldPackageCommand.php b/src/ScaffoldPackageCommand.php index f32bdf0..0a60b30 100644 --- a/src/ScaffoldPackageCommand.php +++ b/src/ScaffoldPackageCommand.php @@ -96,6 +96,7 @@ EOT; "{$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 ), diff --git a/templates/readme-contributing.mustache b/templates/readme-contributing.mustache index c040062..73ff8f4 100644 --- a/templates/readme-contributing.mustache +++ b/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