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 (304 forks)batch import
error-messagegood first issuehelp wantedneeds-tests

Repository metrics

Stars
 (6,624 stars)
PR merge metrics
 (Avg merge 12d 19h) (6 merged PRs in 30d)

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

Research direction
Compile a list of parsing/typechecking errors with examples, marking GOOD or ???.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Documentation
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.
70