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

docs: licenses.md never covers MIT, Apache, BSD, MPL, Unlicense, ISC, `custom` or `public-domain`, roughly a third of the catalog

Đã đóng
  • Có gì không ổn?
#143 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
76/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
Lĩnh vực
devtools, documentation

Hướng nghiên cứu

Start with docs/licenses.md and site/license-vocabulary.json to see the current guide and the complete set of licence values; inspect checks.mjs for the existing check patterns. Add coverage for each value, explain how to read custom entries, and point readers to the CREDITS export. Done when every vocabulary value is covered and a check in checks.mjs keeps that coverage in place.

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

Mô tả

documentation priority: high

Why it matters

The licence cheat sheet is the first guide on the README, the homepage and llms.txt, and it cannot answer the most common tools question: "what do I owe for an MIT add-on in my closed game?" 121 tool entries plus shader and font tooling depend on that answer.

Evidence (at 69387df)

  • Licence distribution in catalog/** frontmatter: MIT 67, custom 61, Apache-2.0 12, BSD-3-Clause 7 (plus BSD-2-Clause, BSD, BSD-3-Clause-Clear), MPL-2.0 2, Unlicense 1, ISC 1, CPL-1.0 1, CDLA-Permissive-2.0 1, public-domain 4, unversioned CC-BY 1.
  • docs/licenses.md (56 lines) has rows for CC licences, ODbL, OFL, a handful of named products and GPL/AGPL. Searching the file for MIT, Apache, Unlicense, ISC or BSD finds nothing; mpl appears once. The "Copyleft tools vs generated output" paragraph (lines 42-44) covers GPL editors but says nothing about permissive notice obligations.
  • The homepage card for Boujie Water Shader (MIT) already says "keep the copyright notice with redistributed copies": the catalog knows the rule but the guide never states it.
  • custom (61 entries, the second most common value) has no row explaining how to read a custom-licence entry: what the catalog promises for it, where the quote lives, and that commercial: true on custom is the catalog's reading of that specific text.

Suggested approach

Add a "Permissive software licences" table (MIT, BSD-2/3, ISC, Apache-2.0 with its NOTICE and patent clause, MPL-2.0 file-level copyleft, Unlicense/public-domain, CPL-1.0, CDLA-Permissive-2.0) with a "What you ship" column (notice file in the credits, nothing more) and a one-paragraph "How to read a custom entry". Point at the shortlist's CREDITS export, which already collects notices. Keep the not-legal-advice banner. Add a cheap check in checks.mjs: every key in site/license-vocabulary.json must appear in docs/licenses.md.

Done when

Every license value in the vocabulary has a row or paragraph in docs/licenses.md, and the check keeps it that way.

Ngôn ngữ chính
JavaScript
Star
58
Fork
15
Merge trung bình
16 giờ 53 phút
Pull request đã merge (30 ngày)
14

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.