Adding an optional design.md document to exercise specifications

未关闭
#2,108 1 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
领域
documentation

调研方向

该 issue 提到了练习规范以及用于概念练习的现有 design.md 文档;请先查看这一约定。没有确定任何实现文件或测试,因此在将可选文档方案视为完成之前,请确认预期位置、格式和验收检查。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Ruby
星标
362
派生
566
平均合并
15 小时 13 分钟
30 天内合并 PR
8

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

exercism/problem-specifications 的其他 Issue

查看 exercism/problem-specifications 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。