Improve docs in Factories
维护者通常 1 天内回复
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 82/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- rust
调研方向
从 bouncycastle-factory 入口点的工厂文档开始，然后对照 bouncycastle-core::traits 中的原语文档。为每个工厂的文档添加指向相应原语文档的链接，并确认每个工厂都为 IDE 用户提供该导航。
由索引模型根据 Issue 内容生成。
描述
If a user starts with bouncycastle-factory as their entry-point to the library, the docs are rather thin. At a minimum, the docs in each factory should link back to the textbook-y docs about that primitive in bouncycastle-core::traits. This is particularly relevant if a user is using exclusively factories, because those are the docs that they will see in their mouse-over popup in their IDE.
- 主要语言
- Rust
- 星标
- 25
- 派生
- 18
- 平均合并
- 56 分钟
- 30 天内合并 PR
- 1
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
bcgit/bc-rust 的其他 Issue
-
good first issue refactor
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
Security: Prevent keystream reuse when cloning or resuming stateful cipher workers可能已有人在做 @officialfrancismendoza 于 1 天前认领。 未关闭enhancement
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
维护者通常 1 天内回复
-
Framework for asm可能已有人在做 @mwcw 于 10 天前认领。 未关闭
难度 5/5 一周以上 新手友好度 12/100
bcgit/bc-rust#168 · 4 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
相似的 Issue
-
bug cli p3
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
Telegram and Twitch adapters panic when splitting long messages with multibyte characters可能已有人在做 @RaphaelFakhri 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
spacedriveapp/spacebot#661 ·
-
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 74/100
project-robius/robrix#1177 ·
维护者通常 1 天内回复