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

Reconcile `code-review.md`'s finding-ID convention with the ID schemes in use (CR-/DOC-/TECH-, F-P4-OPUS, F-P8-C)

Đang mở
  • Có gì không ổn?
#923 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
25/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ệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Start with docs/standards/code-review.md, which defines the two canonical finding-ID forms, then compare it with the CR-/DOC-/TECH- IDs cited in CONTRIBUTING.md and the pull-request template, and the F-P4-OPUS-NN/F-P8-C-NN schemes in the tree. The row itself is at docs/roadmap/risks-and-decisions.md line 93. Done means the convention covers or scopes every ID form, a maintainer has decided on enforcement, the row is removed from the deferral table, and the CHANGELOG names F-PR29-A8-16. Check #712 first to avoid overlap.

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

Mô tả

documentation severity: low source: roadmap wave: 4

Deferred work · F-PR29-A8-16 · severity Low · cost ~1-2 h · recorded in docs/roadmap/risks-and-decisions.md:93

Summary

docs/standards/code-review.md defines exactly two canonical finding-ID forms, but later review cycles introduced F-P4-OPUS-NN and F-P8-C-NN, and CONTRIBUTING.md, the pull-request template and code-review.md itself now tell contributors to quote the backlog's CR- / DOC- / TECH- IDs, which the convention never mentions. The row was recorded as a rolling enforcement target with no guard and no exit criterion.

Condition or budget

None recorded ("rolling").

State today (re-checked 2026-10-09)

The convention table lists two forms; the newer schemes appear in the tree and in the contributor documents.

Related

#712 (strip IDs from code comments) is related, not the same change.

Acceptance criteria

  • The convention covers every ID form in use (or states each one's scope), decides whether enforcement is wanted, and the row gets an exit criterion or is closed.
  • The row is removed from the deferral table and the CHANGELOG names its ID (the table's removal contract).

Recorded in docs/roadmap/risks-and-decisions.md (read at f94595f) and re-checked against the code on 2026-10-09. The row leaves that table only when the fix is on main, the CHANGELOG names its ID and any promised guard exists.

Ngôn ngữ chính
Python
Star
9
Fork
1
Merge trung bình
9 giờ 14 phút
Pull request đã merge (30 ngày)
37

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

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 HodeTech/ForgeLM

Tất cả issue của HodeTech/ForgeLM

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.