CONTRIBUTING and the PR template miss two validator rules and overstate release testing
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 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；當檢查清單中的三個項目都已修正且測試通過時，即表示完成。
由索引模型根據 Issue 內容生成。
描述
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:14site/checks.mjs:115-118,:1018-1045site/sync-counts.mjs:3-10.github/workflows/release.yml:41-61
Details
- Deprecating needs
npm run counts. README counts include listed entries only, sostatus: deprecatedmakes V6 fail. CONTRIBUTING step 5 and the PR template say "adding or removing"; the V6 errors (checks.mjs:1020, :1031, :1037, :1044) never mentionnpm run counts. - New licences also need
site/spdx-allowed.json. CONTRIBUTING:48 mentions onlysite/license-vocabulary.json, but checks.mjs:115-118 rejects anylicense_spdxmissing fromspdx-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
- Set
status: deprecatedon any active entry and add the- Deprecated:line. npm run validatereports 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 isnpm 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 小時
- 30 天內合併 PR
- 12
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
TMHSDigital/Free-Game-Dev-Assets 的其他 Issue
-
enhancement good first issue priority: medium
難度 2/5 1-3 小時 新手友好度 82/100
TMHSDigital/Free-Game-Dev-Assets#272 ·
維護者通常 1 天內回覆
-
documentation good first issue priority: low
難度 2/5 1-3 小時 新手友好度 78/100
TMHSDigital/Free-Game-Dev-Assets#270 ·
維護者通常 1 天內回覆
-
good first issue priority: low tests
難度 2/5 1-3 小時 新手友好度 88/100
TMHSDigital/Free-Game-Dev-Assets#267 ·
維護者通常 1 天內回覆
-
good first issue priority: low tests
難度 2/5 1-3 小時 新手友好度 83/100
TMHSDigital/Free-Game-Dev-Assets#266 ·
維護者通常 1 天內回覆
-
priority: low tests
難度 2/5 1-3 小時 新手友好度 82/100
TMHSDigital/Free-Game-Dev-Assets#265 ·
維護者通常 1 天內回覆
查看 TMHSDigital/Free-Game-Dev-Assets 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 84/100
microsoft/TypeScript#65370 ·
維護者通常 1 天內回覆
-
metrics priority: medium
難度 1/5 1-3 小時 新手友好度 86/100
LearningCircuit/local-deep-research#8336 ·
維護者通常 1 天內回覆
-
ace bug yaml
難度 2/5 1-3 小時 新手友好度 75/100
維護者通常 1 天內回覆
-
svelte: whitespace-only edit leaves an empty todo, edits not trimmed, filter not restored on reload未關閉
難度 2/5 1-3 小時 新手友好度 72/100
-
agentic-workflows
難度 1/5 1 小時以內 新手友好度 85/100
githubnext/gh-cao#20316 ·
維護者通常 1 天內回覆