Merge pull request woocommerce/woocommerce-admin#748 from woocommerce/add/contributing
Add markdown docs with details on contributing
This commit is contained in:
commit
1a46b29b73
|
@ -0,0 +1,24 @@
|
||||||
|
# Contributing to WooCommerce Admin
|
||||||
|
|
||||||
|
Hi! Thank you for your interest in contributing to WooCommerce Admin. We appreciate it.
|
||||||
|
|
||||||
|
There are many ways to contribute – reporting bugs, feature suggestions, and fixing bugs.
|
||||||
|
|
||||||
|
## Reporting Bugs, Asking Questions, Sending Suggestions
|
||||||
|
|
||||||
|
Open [a GitHub issue](https://github.com/woocommerce/wc-admin/issues/new/choose), that's all. If you have write access, add any appropriate labels.
|
||||||
|
|
||||||
|
If you're filing a bug, specific steps to reproduce are always helpful. Please include what you expected to see and what happened instead.
|
||||||
|
|
||||||
|
## We're Here To Help
|
||||||
|
|
||||||
|
We encourage you to ask for help. We want your first experience with WooCommerce Admin to be a good one, so don't be shy. If you're wondering why something is the way it is, or how a decision was made, you can tag issues with [Type] Question or prefix them with “Question:”
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
WooCommerce Admin is licensed under [GNU General Public License v2 (or later)](/LICENSE.md).
|
||||||
|
|
||||||
|
All materials contributed should be compatible with the GPLv2. This means that if you own the material, you agree to license it under the GPLv2 license. If you are contributing code that is not your own, such as adding a component from another Open Source project, or adding an `npm` package, you need to make sure you follow these steps:
|
||||||
|
|
||||||
|
1. Check that the code has a license. If you can't find one, you can try to contact the original author and get permission to use, or ask them to release under a compatible Open Source license.
|
||||||
|
2. Check the license is compatible with [GPLv2](http://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses), note that the Apache 2.0 license is *not* compatible.
|
|
@ -29,3 +29,7 @@ There are also some helper scripts:
|
||||||
## Privacy
|
## Privacy
|
||||||
|
|
||||||
If you have enabled WooCommerce usage tracking ( option `woocommerce_allow_tracking` ) then, in addition to the tracking described in https://woocommerce.com/usage-tracking/, this plugin also sends information about the actions that site administrators perform to Automattic - see https://automattic.com/privacy/#information-we-collect-automatically for more information.
|
If you have enabled WooCommerce usage tracking ( option `woocommerce_allow_tracking` ) then, in addition to the tracking described in https://woocommerce.com/usage-tracking/, this plugin also sends information about the actions that site administrators perform to Automattic - see https://automattic.com/privacy/#information-we-collect-automatically for more information.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
There are many ways to contribute – reporting bugs, feature suggestions and fixing bugs. For full details, please see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||||
|
|
Loading…
Reference in New Issue