0xMiden/compiler

Reduce friction for users when reporting ICE

Open

#157 opened on Mar 28, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (70 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (110 stars)
PR merge metrics
 (Avg merge 4d 7h) (51 merged PRs in 30d)

Description

When ICE happens, the cargo extension could gather all the context (source files, dependencies, Cargo.toml, etc.) and after asking the user's permission, generate a file(output?) that would be posted as an issue in this repo. Alternatively, the cargo extension could interactively ask the user's permission and create the issue (using gh, HTTP API, etc.) and upload all the context info (see above).

### Tasks
- [ ] Check how `rustc` deals with ICE reporting

Contributor guide

Research direction
Investigate how rustc handles ICE reporting and design a similar mechanism for the Miden compiler; then implement a cargo extension to collect context and create an issue.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Mostly clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65