Adding an optional design.md document to exercise specifications

Open
#2,108 1 comment 5 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
Domain
documentation

Research direction

The issue names exercise specifications and the existing design.md document used for concept exercises; start by reviewing that convention. No implementation files or tests are identified, so confirm the intended location, format, and acceptance checks before treating the optional-document scheme as done.

Written by the indexing model from the issue text.

Description

Throughout an exercise's history we often see the same discussions crop up over and over.

For example, in meetup, people want to add tests for fifth (e.g. The fifth Monday of a month).

This has been discussed a number of times, with the conclusion that we will not add logic for fifth, since the exercise is about scheduling regular meetups, and not all months have fifth weeks, which means that scheduling a meetup on the fifth Monday (or whatever) would mean that the meetup no longer met regularly.

In order to make it easier to avoid having the same discussions over and over again, we're going to add a design.md file to exercises where we can summarize the decisions.

This file is optional. We will add them as it makes sense. We chose the name design.md because we have a design.md document for the concept exercises, and the name makes enough sense in this context that we don't think it would be misleading or confusing.

If you can see a reason to do this differently, please raise your objections here! If not, we'll go ahead with this new scheme in a couple of weeks.

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.