Skip to content

Align Debug vs Verbose messaging semantics across commands #647

Description

Context

Messaging use is currently inconsistent across commands.

We need a clear, shared default for when to emit Write-Debug vs Write-Verbose, and what each channel means for maintainers and users.

Problem

Without a standard, messages drift in tone and purpose:

  • operational progress and high-level traces may end up in Debug
  • low-level diagnostics may end up in Verbose
  • callers get inconsistent experience when enabling -Verbose or -Debug

Proposal

Define and adopt a messaging guideline for this repo:

  • Write-Verbose

  • user-facing execution progress and decision summaries

  • useful for understanding what the command is doing

  • should be actionable and readable during normal troubleshooting

  • Write-Debug

  • developer-focused internals and deep diagnostics

  • raw payload details, branch/path internals, API request/response metadata, and temporary instrumentation

  • intended for deep debugging, not routine progress

Scope

  • Audit commands in this repo for messaging usage.
  • Classify existing messages as Verbose vs Debug by intent.
  • Update mismatched calls to align with the standard.
  • Keep message wording concise and consistent.

Acceptance Criteria

  • A documented rule of thumb exists in this repo (README/docs or contributor guidance).
  • Core commands follow the rule with no obvious mismatches.
  • Spot checks show:
    • -Verbose gives useful progress without noisy internals.
    • -Debug adds internals beyond Verbose.
  • Changelog/release note mentions messaging alignment.

Cross-Repo Follow-up

Open/track a companion docs issue in MSXOrg/docs to define this as a reusable default standard for PowerShell modules.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions