Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • KInfoCenter KInfoCenter
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1
    • Issues 1
    • List
    • Boards
    • Service Desk
    • Milestones
  • Bugzilla
    • Bugzilla
  • Merge requests 3
    • Merge requests 3
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • PlasmaPlasma
  • KInfoCenterKInfoCenter
  • Merge requests
  • !90

Display more informative and actionable error messages

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Nate Graham requested to merge ngraham/kinfocenter:better-error-messages into master Mar 04, 2022
  • Overview 11
  • Commits 1
  • Pipelines 8
  • Changes 4

These error messages were a bit short and contained technical jargon. They did not give the user a good sense of how to proceed.

With this commit, the error messages are changed to clearly include the important elements of a good error message:

  1. What went wrong
  2. Why it happened
  3. How they can fix it themselves
  4. How they can report the issue to get it permanently fixed for everyone

To do this, the setError() function is extended to also be able to accept optional explanation and bugReportUrl arguments, which are used to present better information to the user.

@teams/vdg @teams/usability

Before After
"Tool not found" error message Tool_not_found__before Tool_not_found__after
"Tool crashed" error message Tool_crashed__before Tool_crashed__after
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: better-error-messages