cms-dev / cms-dev/cms

Add help tooltips to evaluation outcomes

Open
#1,347 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature_request
Dominant language
Python
Stars
1k
Forks
412
Avg merge
6d 10h
Merged PRs (30d)
3

Description

In the Estonian fork, we rephrased the "killed by signal" message, to move more explanation to the help text, but we removed the "(could be triggered by violating memory limits)" from the outcome name. This confused people, so instead I implemented help tooltips for most failing outcomes, e.g.:

Image

These help texts already exist in the "documentation" tab, but apparently nobody knows to look there.

These are currently implemented as just <span title="...">, but I think it would actually be better to do a custom implementation, so that e.g. tapping on them on mobile causes them to pop up.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by locating the evaluation outcomes UI and the existing help text in the documentation tab, then compare how failing outcomes are rendered. Done means the relevant failing outcomes expose their explanations through custom tooltips that also work when tapped on mobile.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.