wp-cli/scaffold-package-command
2
0
Fork 0
mirror of https://ghproxy.net/https://github.com/wp-cli/scaffold-package-command.git synced 2025-10-04 05:10:07 +08:00
Code Issues Projects Packages Activity Actions

Add a basic CONTRIBUTING.md to point to contrib guidelines

Browse source
This commit is contained in:
Daniel Bachhuber 2017-07-18 06:27:02 -07:00
parent 331cb2649c
commit 7ae9a81c01
4 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md Normal file
View file

@ -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.

5
features/scaffold-package.feature
View file

@ -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/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/wp-cli.yml file should exist
And the {PACKAGE_PATH}/local/wp-cli/foo/.travis.yml file should not exist And the {PACKAGE_PATH}/local/wp-cli/foo/.travis.yml file should not exist



1
src/ScaffoldPackageCommand.php
View file

@ -96,6 +96,7 @@ EOT;
"{$package_dir}/.gitignore" => file_get_contents( "{$package_root}/.gitignore" ), "{$package_dir}/.gitignore" => file_get_contents( "{$package_root}/.gitignore" ),
"{$package_dir}/.editorconfig" => file_get_contents( "{$package_root}/.editorconfig" ), "{$package_dir}/.editorconfig" => file_get_contents( "{$package_root}/.editorconfig" ),
"{$package_dir}/.distignore" => file_get_contents( "{$package_root}/.distignore" ), "{$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}/wp-cli.yml" => $wp_cli_yml,
"{$package_dir}/command.php" => Utils\mustache_render( "{$template_path}/command.mustache", $assoc_args ), "{$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 ), "{$package_dir}/composer.json" => Utils\mustache_render( "{$template_path}/composer.mustache", $assoc_args ),

2
templates/readme-contributing.mustache
View file

@ -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. 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 ### Reporting a bug