docs: bring the roadmap's "Today" column up to date

未关闭 适合新手
#194 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
c, markdown, shell
领域
documentation

调研方向

从 docs/roadmap.md 开始,将每个“Today”单元格与 .github/workflows/ci.yml、.github/workflows/nightly.yml、docs/internals/scoreboard.md 和 docs/internals/status.md 对照检查。运行 sh tools/scoreboard.sh --quick 获取当前测量结果;这需要 clang 和 llvm-nm。只更新过时的说法,为每个数字注明日期和来源,然后运行 make embdoc && ./embdoc check;每个单元格都准确且链接检查通过即为完成。

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

描述

documentation good first issue

Context. docs/roadmap.md says what 1.0 promises, and in its "Today" column how far EmbCC is from each promise. That column was written for 0.0.1-beta (October 2026), and parts of it are no longer true. For example:

  • "No CI on pull requests. The matrix runs on a developer machine." Since #182, every pull request runs the full suite, a fuzz job and check-self (.github/workflows/ci.yml), and the nightly workflow runs GCC's torture suite and more fuzzing (.github/workflows/nightly.yml).
  • The refusal counts (110 backend, 134 front-end) and the code-size ratios (2026-10-24) have newer measurements in docs/internals/scoreboard.md.
  • The documentation row says the status page "still lists C++ as refused on Cortex-M". Check docs/internals/status.md to see whether that is still so.

Where. Only docs/roadmap.md. The facts come from .github/workflows/, docs/internals/scoreboard.md, docs/internals/status.md, and the commands below.

Steps.

  1. For each row, check the "Today" cell against the repository. Run sh tools/scoreboard.sh --quick for the size and refusal numbers. It needs clang and llvm-nm, and takes a few minutes.
  2. Rewrite only what is no longer true, and give the date and source of every number, as the existing cells do.
  3. Run make embdoc && ./embdoc check to make sure every link still resolves.

Done when every "Today" cell is true on main, each number names where it comes from, and ./embdoc check reports no broken links.

Before you start: the contributor's guide has the rules. A new test counts only after it has failed against the code before your change, and a commit subject reads area: summary. Questions are welcome in the comments or in Discussions.

主要语言
C
星标
1
派生
2
平均合并
20 小时 55 分钟
30 天内合并 PR
73

环境准备

从这里开始

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

EmbLinkOs/EmbCC 的其他 Issue

查看 EmbLinkOs/EmbCC 的全部 Issue

相似的 Issue

更多 C Issue

把新 issue 发到你的邮箱

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