Skip to content

Bugfix workflow: Guide agent to consider UX implications in error handling #58

@kami619

Description

@kami619

Problem

The agent's initial fix threw a click.BadParameter error for both CLI and config file exclusions. This meant that configuration file errors were reported as CLI parameter errors, creating a poor user experience. It took an external automated review to point out this UX issue.

Impact

  • Suboptimal user experience (confusing error messages)
  • Required external intervention to catch the issue
  • Agent didn't proactively consider the context difference between CLI and config errors

Context

This issue was identified during the bugfix session for ambient-code/agentready#306 addressing ambient-code/agentready#302.

The agent should have recognized that:

  • CLI errors → click.BadParameter (appropriate)
  • Config file errors → click.ClickException (better UX)

Recommended Solution

The bugfix workflow should:

  • Include guidance in the /fix phase about considering error message UX
  • Add a checklist item: "Ensure error messages clearly indicate the source of the problem"
  • Prompt the agent to think about different error contexts (CLI vs. config vs. runtime)
  • Consider adding a review step that specifically checks error handling paths

Could add a "User Experience Review" section that prompts the agent to:

  • Test error paths manually
  • Verify error messages are clear and actionable
  • Ensure errors point users to the right place to fix issues

Reference

From PR comment: #42 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions