Release docs: missing labels, broken changelog link, inconsistent notes path
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 82/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- javascript, markdown
调研方向
先查看列出的发布文档：docs/RELEASE.md、releases/RELEASE_NOTES_v0.1.0.md 和 releases/RELEASE_GUIDE_v0.1.0.md；同时核对仓库的标签名称和 package.json 中的版本。修正发布说明和模板中的标签列表、说明文档路径、变更日志链接和版本指南。列出的每项差异都得到处理后即为完成。
由索引模型根据 Issue 内容生成。
描述
Summary
Several statements in the release documentation do not match the repository.
Where
docs/RELEASE.md:10,:16-19,:67,:72releases/RELEASE_NOTES_v0.1.0.md:60,releases/RELEASE_GUIDE_v0.1.0.md:6
Details
- Labels (
:72). The triage line namesa11yandperf; neither label exists in the repository. - Notes path (
:10,:18). Both say to createRELEASE_NOTES_vX.Y.Z.mdwith no directory; only:46saysreleases/. The workflow looks inreleases/first.releases/RELEASE_GUIDE_v0.1.0.md:6has the same omission. - Broken link.
releases/RELEASE_NOTES_v0.1.0.md:60links[CHANGELOG.md](CHANGELOG.md), which does not resolve fromreleases/or from the published release page. - Version.
package.jsonis0.0.0althoughv0.1.0is released, and the release steps never mention the version field.
Suggested fix
Create the two labels or drop them from the list. Write releases/RELEASE_NOTES_vX.Y.Z.md everywhere. Use an absolute URL for the changelog link in the notes and in the template. Add a "bump the package version" step or state that the field is unused.
Acceptance criteria
- Each item above is corrected
Getting started
- Relevant files:
docs/RELEASE.md,releases/RELEASE_NOTES_v0.1.0.md,releases/RELEASE_GUIDE_v0.1.0.md - How to run tests:
npm install, thennpm testandnpm run lint - Related docs:
docs/ARCHITECTURE.md,.github/CONTRIBUTING.md
Filed by repo-audit/full-audit at 8a2c86c. Severity: low. Effort: S. audit-key: documentation|docs/RELEASE.md|release-process
- 主要语言
- JavaScript
- 星标
- 4
- 派生
- 2
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
TMHSDigital/Static_Chess 的其他 Issue
-
enhancement good first issue severity: medium
难度 2/5 1-3 小时 新手友好度 78/100
TMHSDigital/Static_Chess#53 ·
-
documentation good first issue severity: low
难度 2/5 1-3 小时 新手友好度 72/100
TMHSDigital/Static_Chess#49 ·
-
documentation good first issue severity: low
难度 2/5 1-3 小时 新手友好度 83/100
TMHSDigital/Static_Chess#48 ·
-
documentation severity: medium
难度 2/5 1-3 小时 新手友好度 78/100
TMHSDigital/Static_Chess#47 ·
-
documentation good first issue severity: low
难度 1/5 1-3 小时 新手友好度 82/100
TMHSDigital/Static_Chess#45 ·
查看 TMHSDigital/Static_Chess 的全部 Issue
相似的 Issue
-
good first issue tests
难度 1/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 90/100
-
1️⃣ phase/under-investigation flaky/confirmed flaky/needs-decision type/bug
难度 2/5 1-3 小时 新手友好度 65/100
growilabs/growi#12246 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
TMHSDigital/Free-Game-Dev-Assets#301 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 79/100