Adding an optional design.md document to exercise specifications

Đang mở
#2,108 1 bình luận 5 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Issue nêu các đặc tả bài tập và tài liệu design.md hiện có được dùng cho các bài tập khái niệm; hãy bắt đầu bằng việc xem xét quy ước đó. Không có tệp triển khai hoặc bài kiểm thử nào được xác định, vì vậy hãy xác nhận vị trí dự kiến, định dạng và các kiểm tra nghiệm thu trước khi coi sơ đồ tài liệu tùy chọn là hoàn tất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Ruby
Star
362
Fork
566
Merge trung bình
15 giờ 13 phút
Pull request đã merge (30 ngày)
8

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của exercism/problem-specifications

Tất cả issue của exercism/problem-specifications

Issue tương tự

Thêm issue về Ruby

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.