missing/outdated crate documentation
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- rust
调研方向
Start by comparing the crate documentation, examples, and romans blog, focusing on StableBTreeMap, StableMinHeap, StableVec, and schema upgrades. Review how Bound::Bound and upgrade pitfalls are currently described. Done means the documentation and examples are synchronized and cover the listed structures, usage patterns, and upgrade guidance.
由索引模型根据 Issue 内容生成。
描述
- romans blog, the crate docs and the examples are not in sync. this is mainly around the fact that
StableBTreeMapdoes not require devs to specify a bound anymore - there aren't examples for how to use the library except for
StableMinHeapandStableBTreeMap -
StableVecrequiresBound::Bound, which is not documented and compiles, but throws runtime errors - more docs and examples around schema upgrades and what pitfalls to avoid
- 主要语言
- Rust
- 星标
- 111
- 派生
- 39
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
dfinity/stable-structures 的其他 Issue
-
难度 5/5 一周以上 新手友好度 25/100
dfinity/stable-structures#439 ·
-
难度 3/5 1-2 天 新手友好度 35/100
dfinity/stable-structures#400 ·
-
难度 5/5 一周以上 新手友好度 35/100
dfinity/stable-structures#382 ·
-
Add StableVec::extend method可能已有人在做 @gabrielrondon 于 210 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 45/100
dfinity/stable-structures#349 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
dfinity/stable-structures#264 · 1 条评论 ·
查看 dfinity/stable-structures 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
good first issue gpu serve
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 80/100
维护者通常 1 天内回复
-
documentation E-easy good first issue help wanted
难度 1/5 1-3 小时 新手友好度 91/100
维护者通常 1 天内回复