exercism / exercism/euphoria

Unclear testing directions

Closed
#133 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Euphoria
Stars
3
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Looking at docs/TESTS.md, the editing section is unclear. What is `--`? I know we're essentially commenting out the test, but the student may not catch that. Also, what happens if a test is across multiple lines? There also aren't instructions on how specifically to enable the tests. It's implied we're supposed to uncomment the test, but a student may miss this piece of information.

We're also telling students to enable tests until they're passing, but we're not indicating how to know if a test is passing.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read docs/TESTS.md, focusing on the editing section. Clarify what `--` means, how to handle tests spanning multiple lines, how to enable tests, and how students can tell when a test is passing; done when the instructions answer each of these questions clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.