From 3b974da08fc26188c838b595aa86b827f05f9bf2 Mon Sep 17 00:00:00 2001 From: Mike Jolley Date: Wed, 26 Jun 2019 17:20:47 +0100 Subject: [PATCH] Update readme and contributing docs --- .github/CONTRIBUTING.md | 23 +++++++++++++++-------- .travis.yml | 2 +- README.md | 3 --- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4491e491985..9d8ba92ac9a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,7 +12,7 @@ If you think something can be improved and you wish to contribute code, [fork](https://help.github.com/articles/fork-a-repo/) WooCommerce, commit your changes, and [send a pull request](https://help.github.com/articles/using-pull-requests/). We'll be happy to review your changes! -## Feature Requests +## Feature Requests 🚀 Feature requests can be [submitted to our issue tracker](https://github.com/woocommerce/woocommerce/issues/new?template=Feature_request.md). Be sure to include a description of the expected behavior and use case, and before submitting a request, please search for similar ones in the closed issues. @@ -20,7 +20,7 @@ Feature request issues will remain closed until we see sufficient interest via c You can see a [list of current feature requests which require votes here](https://github.com/woocommerce/woocommerce/issues?q=label%3A%22votes+needed%22+label%3Aenhancement+sort%3Areactions-%2B1-desc+is%3Aclosed). -## Technical Support / Questions +## Technical Support / Questions ❓ We don't offer technical support on GitHub so we recommend using the following: @@ -42,18 +42,25 @@ https://woocommerce.com/contact-us/ - [WooExperts](https://woocommerce.com/experts/) - [Codeable](https://codeable.io/) -## Coding Guidelines +## Coding Guidelines and Development 🛠 -- **Ensure you stick to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/)** +WooCommerce core uses NPM and Grunt for build tasks, and Composer for installing packages and dependencies. To get your development environment running we recommend [reading here](https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment). + +If you are contributing code to the REST API or editor blocks, these are developed in external packages. +- [WooCommerce REST API package](https://github.com/woocommerce/woocommerce-rest-api) +- [Blocks](https://github.com/woocommerce/woocommerce-gutenberg-products-block) + +When writing code for WooCommerce: +- **Ensure you follow to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/)** - Install our pre-commit hook using composer. It'll help with the Coding Standards. To install run `composer install` from the command line within the woocommerce plugin directory. - Ensure you use LF line endings in your code editor. Use [EditorConfig](http://editorconfig.org/) if your editor supports it so that indentation, line endings and other settings are auto configured. - When committing, reference your issue number (#1234) and include a note about the fix. -- Ensure that your code is compatible with PHP 5.2+. -- Push the changes to your fork and submit a pull request on the master branch of the WooCommerce repository. Existing maintenance branches will be maintained by WooCommerce developers. +- Ensure that your code supports the minimum supported versions of PHP and WordPress; this is shown at the top of the `readme.txt` file. +- Push the changes to your fork and submit a pull request on the master branch of the WooCommerce repository. -Please **don't** modify the changelog or update the .pot files. These will be maintained by the WooCommerce team. +Please avoid modifying the change-log directly or updating the .pot files. These will be updated by the WooCommerce team. -## Translating WooCommerce +## Translating WooCommerce 💬 We have a [project on translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/woocommerce). You can join the localization team of your language and help by translating WooCommerce. [Find more about using joining a language team and using GlotPress](https://make.wordpress.org/polyglots/handbook/tools/glotpress-translate-wordpress-org/). diff --git a/.travis.yml b/.travis.yml index 32cda3dfe28..d4099c1e5b9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -54,7 +54,7 @@ before_script: else echo "xdebug.ini does not exist" fi - - composer install + - composer install --no-dev - | # Install WP Test suite, install PHPUnit globally if needed: if [[ ! -z "$WP_VERSION" ]]; then diff --git a/README.md b/README.md index 4b67ef66c61..099eb8d3e8c 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,3 @@ Support requests in issues on this repository will be closed on sight. ## Contributing to WooCommerce If you have a patch or have stumbled upon an issue with WooCommerce core, you can contribute this back to the code. Please read our [contributor guidelines](https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md) for more information how you can do this. - -## Contributing new features to the WooCommerce REST API -If you'd like to add a feature to the next version of the REST API, contribute here: https://github.com/woocommerce/wc-api-dev