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 天内回复