Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding an optional design.md document to exercise specifications #2108

Open
kytrinyx opened this issue Oct 3, 2022 · 1 comment
Open

Adding an optional design.md document to exercise specifications #2108

kytrinyx opened this issue Oct 3, 2022 · 1 comment

Comments

@kytrinyx
Copy link
Member

kytrinyx commented Oct 3, 2022

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.

@jiegillet
Copy link
Contributor

We do this in the Elixir track, it works great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants