chakra-core/ChakraCore

Improve error messages

Open

#2,658 opened on Mar 9, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (1,374 forks)batch import
Dev ExperienceTaskhelp wanted

Repository metrics

Stars
 (9,000 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

In order to provide the best possible development experience, we should improve error messages to call out as much information as possible (which parameter, which field, actual/expected types, etc.) when something goes wrong.

Sub-issues:

Fixed

  • #424 (fixed)
  • #2901

Poor / difficult to understand messages

Nice-to-have improvements

  • Follow up issue #2411 and PR #2648 (improved by the PR but still needs more work)

Contributor guide

Research direction
Review the linked issues (#434, #2872, #2411) to understand the specific error messages needing improvement. Identify the source code locations where these messages are generated and ensure they provide clear parameter names, expected/actual types, and context.
Tech stack
javascript
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75