Skip to content

docs(readme): fix typos in architecture and hardware sections#6

Open
MrZ-zhy wants to merge 1 commit into
natesales:mainfrom
MrZ-zhy:contrib/init-2026-06-14
Open

docs(readme): fix typos in architecture and hardware sections#6
MrZ-zhy wants to merge 1 commit into
natesales:mainfrom
MrZ-zhy:contrib/init-2026-06-14

Conversation

@MrZ-zhy

@MrZ-zhy MrZ-zhy commented Jun 14, 2026

Copy link
Copy Markdown

变更摘要

本文档修正 OpenReactor README 中的 3 处小 typo,属于主动改进(上游 0 open issues):

  • L49vacuum guagesvacuum gauges(拼写)
  • L126communicates communicatescommunicates(重复词)
  • L178to control an monitorto control and monitor(a/an 错配)

仅修改 README.md,无任何代码或行为变更;3 行净修改。

关联Issue

无可关联的 open issue(上游 natesales/openreactor 当前 0 open issues),本 PR 为主动贡献。

变更类型

  • Bug修复
  • 文档完善
  • 测试补充
  • 性能优化
  • 新功能
  • 代码重构

测试方法

  • 静态检查:修改后 wc -l 仍为 226 行,27 标题 / 15 表行 / 52 链接结构完整
  • 渲染检查:所有 markdown 标题层级、链接、表格语法未变

测试结果

  • 本地测试全部通过(无 .go 文件变更,编译门禁 N/A)
  • 新增测试覆盖变更代码(docs 改动,N/A)
  • 无既有测试被破坏

自检清单

  • 代码风格与项目一致(仅纯英文文本修正)
  • 无硬编码值
  • 物理单位一致(未涉及物理量)
  • 数值精度足够(未涉及数值计算)
  • 添加了必要的注释
  • 遵循 Conventional Commits(docs(readme): fix typos ...

回滚方案

git revert <merge-commit-sha> 或在 README.md 还原 3 行即可;零运行时影响。

Three small documentation corrections found while reading the README:

- L49: 'vacuum guages' -> 'vacuum gauges' (spelling)
- L126: 'communicates communicates' -> 'communicates' (duplicate word)
- L178: 'to control an monitor' -> 'to control and monitor' (a/an typo)

No code or behavior changes; README only.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant