basalt-rs/bedrock

Add explanation to visible tests

Open

#24 opened on May 12, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (0 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Add optional explanations to visible tests to be shown in the UI with the tests

It should also support markdown.

[[packet.problems.tests]]
input = "hello"
output = "olleh"
visible = true
explanation = '''
`olleh` is the reverse of the string `hello`.
'''

Contributor guide

Research direction
Investigate the current test structure in TOML definitions and the UI rendering code. Add an optional 'explanation' field to visible test entries, ensuring markdown support in the UI display.
Tech stack
rust
Domain
testingdeveloper 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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rusttoml
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70