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

オープン 初心者向け
  • 何か問題がありますか？
#269 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript, node.js
領域
documentation, testing

調査の方向性

CONTRIBUTING.md、.github/PULL_REQUEST_TEMPLATE.md、site/checks.mjsの指定されたセクションを読み、リリースワークフローとNode 22のCIジョブを比較します。コントリビューター向けガイダンスとV6メッセージを更新し、バリデーターとワークフローの動作に合わせます。npm testを実行します。チェックリストの3項目すべてが修正され、テストが成功したら完了です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
JavaScript
スター
58
フォーク
15
平均マージ
1日 15時間
マージ済み PR（30日）
12

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TMHSDigital/Free-Game-Dev-Assets のほかの issue

TMHSDigital/Free-Game-Dev-Assets の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。