Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Fermée
  • Quelque chose ne va pas ?
#143 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
76/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript
Domaine
devtools, documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
JavaScript
Étoiles
58
Forks
15
Merge moyen
16 h 53 min
PR mergées (30 j)
14

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Free-Game-Dev-Assets

Toutes les issues de TMHSDigital/Free-Game-Dev-Assets

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.