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

Check readme examples

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

维护者通常 12 天内回复

已经有一个关联 PR 被合并了。

  • #256 来自 @Pfeil —— 已合并

评估

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

调研方向

首先根据当前 Java API 检查 README 中的示例,尤其是过时的 addContent 方法,并查阅 v2.0.0 发布说明中的迁移指南。完成的标准是示例已更新;此外还要确定现有示例是否有测试覆盖,以及 README 是否应只保留一个代表性示例。

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

描述

documentation good first issue

The readme examples are partially outdated. For example, it still shows the addContent method.

  • This should be fixed and the examples should be checked
  • Consider some automated workflow for the examples. The Readme is a bit bloated with examples anyway. We should consider making tests out of them (if they aren't) and link to them instead. This will shorten the readme. We could keep one representational example in the readme so the user gets an immediate idea of how this will work.

Side note: I added a transition guide in the release notes of v2.0.0 regarding the renamed addContent function.

主要语言
Java
星标
5
派生
4
平均合并
12 天 10 小时
30 天内合并 PR
8

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

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

从这里开始

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

kit-data-manager/ro-crate-java 的其他 Issue

查看 kit-data-manager/ro-crate-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

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