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

JDK 13+ : Headings should start with `h2` and `h4`

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
java
领域
documentation

调研方向

首先复现针对 JDK 13+ 所描述的 Maven Javadoc 失败问题,并阅读 JDK-8220379 了解标题规则。找到用于迁移 Java 文档的 recipe 入口点和测试;当模块、包、类型和嵌套类型的标题以 h2 开始,成员标题以 h4 开始,并且 Javadoc 生成成功时,即表示完成。

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

描述

recipe
Headings in documentation comments for all modules, packages and types (including nested types) should begin at <h2>.
Headings in members should begin at <h4>.

Currently, this leads to the following failure:

MavenReportException: Error while generating Javadoc: 
[ERROR] Exit code: 1
[ERROR] /MyClass.java:24: error: unexpected heading used: <H1>, compared to implicit preceding heading: <H1>
[ERROR]  * <h1>My heading</h1>

Changing it to <h2> is enough to fix it

See https://bugs.openjdk.org/browse/JDK-8220379

主要语言
Java
星标
156
派生
129
平均合并
7 小时 21 分钟
30 天内合并 PR
42

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

openrewrite/rewrite-migrate-java 的其他 Issue

查看 openrewrite/rewrite-migrate-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

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