Error Message Consistency Audit #243

New issue

Closed

opened 2025-12-28 19:59:09 -08:00 by jwilger · 0 comments

jwilger commented

2025-12-28 19:59:09 -08:00

(Migrated from github.com)

Overview

Audit and ensure consistency, clarity, and actionability of error messages across all EventCore crates. Error quality is foundational - this ensures error messages are consistent in format, provide appropriate context, and are actionable.

Audit Scope

Consistency Audit

Error message format consistency
Error type usage consistency
Context inclusion patterns
Action suggestion patterns

Clarity Audit

Are error messages understandable?
Do messages explain WHAT failed and WHY?
Are technical terms explained?

Actionability Audit

Does each error suggest next steps?
Are links to documentation included?
Do validation errors show actual vs expected values?

Acceptance Criteria

All errors include relevant context (stream IDs, versions)
All errors explain what failed and why
Error format is consistent across all crates
Version conflict errors provide full context (stream IDs, current/expected versions)
Business rule violations include context for debugging
Critical issues fixed, minor issues tracked

Migrated from beads issue: eventcore-016

## Overview Audit and ensure consistency, clarity, and actionability of error messages across all EventCore crates. Error quality is foundational - this ensures error messages are consistent in format, provide appropriate context, and are actionable. ## Audit Scope ### Consistency Audit - Error message format consistency - Error type usage consistency - Context inclusion patterns - Action suggestion patterns ### Clarity Audit - Are error messages understandable? - Do messages explain WHAT failed and WHY? - Are technical terms explained? ### Actionability Audit - Does each error suggest next steps? - Are links to documentation included? - Do validation errors show actual vs expected values? ## Acceptance Criteria - [ ] All errors include relevant context (stream IDs, versions) - [ ] All errors explain what failed and why - [ ] Error format is consistent across all crates - [ ] Version conflict errors provide full context (stream IDs, current/expected versions) - [ ] Business rule violations include context for debugging - [ ] Critical issues fixed, minor issues tracked --- *Migrated from beads issue: eventcore-016*