Make descriptions unique

Open
#2,020 5 comments 2 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
json
Domain
testing

Research direction

Start by reading the linked pull request discussion and locating the JSON schema referenced in the issue. Determine whether concatenated descriptions, including parent test case groupings, can be constrained there. Done means the uniqueness rule is documented or encoded in the schema with suitable validation coverage.

Written by the indexing model from the issue text.

Description

Recently, there was some discussion on whether test case descriptions should be unique: https://github.com/exercism/problem-specifications/pull/2019#discussion_r855117856
IMO there is an unwritten rule that each description should be unique, but it is not documented anywhere I think.
To me, it seems like having unique descriptions is useful for several reasons:

  • It makes for easier identification of test cases (descriptions are easier to scan than UUIDs)
  • It is often a prerequisite for test generators that a (full) description is unique

To be clear, when I'm referring to a description being unique, what I mean is that the concatenated description of a test case must be unique. In other words, the uniqueness also takes into account any description of parent test case goupings.

@wolf99 Would something like this be possible to encode in the JSON schema we have?

Dominant language
Ruby
Stars
362
Forks
566
Avg merge
15h 13m
Merged PRs (30d)
8

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from exercism/problem-specifications

All issues in exercism/problem-specifications

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.