Automattic / Automattic/woocommerce-services

Differentiate "debug" from "logging"

Open
#878 0 comments 0 reactions 0 assignees View on GitHub
[Type] Spike woocommerce-services
Dominant language
JavaScript
Stars
112
Forks
31
Avg merge
3d 1h
Merged PRs (30d)
14

Description

Other WooCommerce extensions (like for Shipping and Payment) have debug options that show verbose output to admins in several places, including (but not limited to): Order Notes and Checkout.

Adding this functionality will help merchants more quickly diagnose problems and/or confirm that WCS is working as expected.

![usps_extension_debug](https://cloud.githubusercontent.com/assets/63922/23670549/4cd6c7f4-0325-11e7-9d10-fbe2f3a13a9b.png)

See https://github.com/Automattic/woocommerce-services/issues/223 for more detail.

EDIT:

- [ ] Catalogue what types of debug messages/data are shown by existing shipping and payment extensions
- [ ] Determine what useful debugging information can be shown by our plugin without (and with) server changes
- [ ] Write up a proposal for the changes to be made

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue #223 and the debug options in existing shipping and payment extensions. Catalogue the debug messages shown in places such as Order Notes and Checkout, then identify what useful information WooCommerce Services can expose without or with server changes. Done means a written proposal covering the requested debugging behavior and scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.