Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Design Notes need to be formalized as specifications

Đang mở
#346 0 bình luận 0 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Start by locating the design notes in the repository and reading them to identify which documents need migration; the issue does not name specific files or a target specification format. Keep the original notes somewhere deep in the repository for history, and rewrite the design documents so they read as human-readable specifications. Done when the migrated documents read as specifications rather than records of decisions.

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

Mô tả

area:docs
Area

core:docs

What

Design notes read as a bunch of decisions and are totally unreadable by humans. This should be formalized as a specification. Keep the notes for history somewhere deep in the repo, but make these documents human readable as specifications

Done when

Design notes should be migrated to a format that reads like a specification rather than a long document of decisions

Ngôn ngữ chính
Python
Star
205
Fork
17
Merge trung bình
3 giờ 49 phút
Pull request đã merge (30 ngày)
89

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

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

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 txoof/PaperPi

Tất cả issue của txoof/PaperPi

Issue tương tự

Thêm issue về Python

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.