Adding an optional design.md document to exercise specifications
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from exercism/problem-specifications
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
exercism/problem-specifications#2686 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
exercism/problem-specifications#2704 · 21 comments · 8 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 35/100
exercism/problem-specifications#2153 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
exercism/problem-specifications#2120 · 7 comments ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
exercism/problem-specifications#2083 ·
Maintainers usually reply within 1 day
All issues in exercism/problem-specifications
Similar issues
-
開発用DockerイメージにPlaywrightのシステム依存を追加するPossibly taken @momocus claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
sakazuki-org/sakazuki#1453 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
jenkins-infra/jenkins.io#9615 · 1 comment ·
Maintainers usually reply within 1 day
-
fix(ocr): compile the Tesseract-free pipeline with Tokio runtimePossibly taken @Goldziher claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Metric tooltips that contradict how the metric is calculatedPossibly taken @aniadeadu claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
WikiEducationFoundation/WikiEduDashboard#7303 · 1 comment ·
Maintainers usually reply within 1 day
-
WhatsApp Cloud template sync saves a partial template list when one page of the Graph API response failsPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days