Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

docs: ROADMAP.md contradicts the stacks, the feeds and a closed issue, and one sentence is broken

已关闭
#145 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
56/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
github, javascript

调研方向

Read ROADMAP.md, compare its claims with stacks/, site/README.md, site/lib/exports.mjs, and the referenced issues. Rewrite the three sections with current facts, move older Done items to docs/review-ledger.md, and add a check in the monthly re-verify workflow that ROADMAP issue references remain open. Done when ROADMAP has no contradictions and its broken sentence is whole.

由索引模型根据 Issue 内容生成。

描述

documentation priority: medium

Why it matters

ROADMAP is where CONTRIBUTING and the README send new contributors to find work. #69 fixed an earlier round of the same drift, so a guard is worth adding this time.

Evidence (at 69387df)

  • ROADMAP.md:14: "Starter stacks: audio, a game-jam kit, Unity, Unreal and VR are not covered yet." stacks/3d-third-person-unreal.md exists and is linked from README.md:147 and the homepage.
  • ROADMAP.md:11-13 offers #41 (camera_perspective / grid_dimensions) as "a good first PR"; #41 is closed and camera_perspective is set on 50 entries. The remaining gap is open #98.
  • ROADMAP.md:21-22: the inserted sentence about reverify.yml splits the original one, leaving the fragment "together in mid-2027." dangling on line 22.
  • ROADMAP.md:33-34 says feed.xml is "of recently verified entries"; site/README.md:26-30 and site/lib/exports.mjs:103-109 say feed.xml is new sources by added and reverified.xml is the verified feed.
  • ROADMAP.md:8 names the thin categories as "video, animation and environment"; shaders-vfx (18) is now tied with animation (18), both below environment (20).

Suggested approach

Rewrite the three sections with today's facts; replace issue numbers with label links (good first issue, gap) so the file does not go stale when issues close; move "Done" items older than a quarter into docs/review-ledger.md. Add a small check (a gh call in the monthly re-verify workflow is enough) that every #N in ROADMAP is still open.

Done when

No sentence in ROADMAP contradicts stacks/, site/README.md or the issue tracker; the broken sentence is whole.

主要语言
JavaScript
星标
58
派生
15
平均合并
18 小时 42 分钟
30 天内合并 PR
11

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/Free-Game-Dev-Assets 的其他 Issue

查看 TMHSDigital/Free-Game-Dev-Assets 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。