Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Chiusa
  • Qualcosa non va?
#143 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
76/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
devtools, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
58
Fork
15
Merge medio
16h 53m
PR unite (30g)
14

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Free-Game-Dev-Assets

Tutte le issue di TMHSDigital/Free-Game-Dev-Assets

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.