CONTRIBUTING and the PR template miss two validator rules and overstate release testing

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#269 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, node.js
Lĩnh vực
documentation, testing

Hướng nghiên cứu

Đọc các phần được nêu trong CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md và site/checks.mjs, sau đó so sánh quy trình phát hành với job CI Node 22. Cập nhật hướng dẫn dành cho người đóng góp và các thông báo V6 để khớp với hành vi của trình xác thực và quy trình làm việc. Chạy npm test; hoàn tất khi cả ba mục trong danh sách kiểm tra được sửa và các bài kiểm tra đều đạt.

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

Mô tả

documentation priority: medium

Summary

Contributors who deprecate an entry or add a new licence hit validator failures the docs do not predict, and CONTRIBUTING says releases run on Node 22 when they do not.

Where

  • CONTRIBUTING.md:39, :48, :68, :73
  • .github/PULL_REQUEST_TEMPLATE.md:14
  • site/checks.mjs:115-118, :1018-1045
  • site/sync-counts.mjs:3-10
  • .github/workflows/release.yml:41-61

Details

  • Deprecating needs npm run counts. README counts include listed entries only, so status: deprecated makes V6 fail. CONTRIBUTING step 5 and the PR template say "adding or removing"; the V6 errors (checks.mjs:1020, :1031, :1037, :1044) never mention npm run counts.
  • New licences also need site/spdx-allowed.json. CONTRIBUTING:48 mentions only site/license-vocabulary.json, but checks.mjs:115-118 rejects any license_spdx missing from spdx-allowed.json.
  • Releases run on Node 24 only. CONTRIBUTING:73 says every release runs on 24 and 22; only ci.yml has the Node 22 job.

Impact

Avoidable validator failures for contributors and an overstated testing claim.

Steps to reproduce

  1. Set status: deprecated on any active entry and add the - Deprecated: line.
  2. npm run validate reports V6 count errors with no hint of the fix.

Suggested fix

Say "adding, removing or deprecating" in CONTRIBUTING step 5, the status bullet and the PR template; append "(run npm run counts)" to the V6 messages; add "and its SPDX id to site/spdx-allowed.json" at :48; say PRs and pushes run on 24 and 22 and releases on 24.

Acceptance criteria

  • Every checklist item fixed

Getting started

  • Relevant files: CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md, site/checks.mjs
  • Run the tests: npm test; the full local gate is npm run check (Node 22+, no install step)
  • Related docs: CONTRIBUTING.md, site/README.md

Filed by repo-audit/full-audit at 4adb944. Severity: medium. Effort: S. audit-key: documentation|CONTRIBUTING.md|counts-spdx-release

Ngôn ngữ chính
JavaScript
Star
58
Fork
15
Merge trung bình
1 ngày 15 giờ
Pull request đã merge (30 ngày)
12

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 TMHSDigital/Free-Game-Dev-Assets

Tất cả issue của TMHSDigital/Free-Game-Dev-Assets

Issue tương tự

Thêm issue về JavaScript

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.