unisonweb/unison

Transcript for tracking improvements and regressions to parse / type errors

Open

#2,207 opened on Jul 13, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (6,624 stars) (304 forks)batch import
error-messagegood first issuehelp wantedneeds-tests

Description

Idea is to introduce a transcript, error-messages.md, which just has a bunch of examples of things that don’t parse/typecheck.

For each example, indicate GOOD if the error message is good, or ??? if it’s bad or confusing.

This will let us track improvements and regressions to our error reporting.

Contributor guide

Tech stack
None
Domain
developer experience
Issue type
feature
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.
stale
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.
90
Research direction
Create a new file `error messages.md` in the repository. Collect examples of parse/type errors, marking each as GOOD or ??? based on message quality. Reference existing error messages in the codebase, and consider linking to any prior discussions or PRs about error message improvements.