Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md with PR instructions (https://github.com/woocommerce/woocommerce-admin/pull/1066) 

When I was trying to commit on a fresh clone, I discovered we have to `composer install` before we can commit. So I updated our documentation to reflect that and gave it a home in some other instructions.
This commit is contained in:
Kevin Killingsworth 2018-12-11 21:02:08 -06:00 committed by GitHub
parent 8ad6ce9f06
commit 92d79bf605
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/woocommerce-admin/CONTRIBUTING.md
View File

@ -14,6 +14,28 @@ If you're filing a bug, specific steps to reproduce are always helpful. Please i
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:”
## Contributing Code
If you're a first-time code contributor to the repository, here's a quick guide to get started:
1. Fork the repo to your own account.
2. Clone your fork into the `wp-content/plugins` directory of your preferred WordPress development environment.
3. Don't forget to create a branch to keep your changes. (`git checkout -b add/my-cool-thing`).
4. From the `wc-admin` plugin directory, build with `npm install` and `npm start`.
5. Visit your dev environment in the browser to enable the `WooCommerce Admin` plugin and try it out.
Tips:
- Try to keep each PR small (around 200-250 lines or less, if you can), and having multiple very small commits in each PR is preferable to one larger commit (especially if the PR is larger).
- Don't combine code formatting changes with meaningful ones. If there's formatting work that needs to be done en masse, do it all in one PR, then open another one for meaningful code changes.
- Add unit tests to your PR for better code coverage and review.
After you've made your updates, you're ready to commit:
1. Run a complete build via `npm run build`.
2. Do a `composer install` to ensure PHP dependencies can run on the pre-commit hook.
3. Create your commit. Write a descriptive, but short first line (e.g. "Reports: Reticulate the splines"), and add more details below. If your commit addresses a github issue, reference it by number here (e.g. "This commit fixes issue #123 by reticulating all the splines.")
4. Push the branch up to your local fork, then create a PR via the GitHub web interface.
## License
WooCommerce Admin is licensed under [GNU General Public License v2 (or later)](/LICENSE.md).