Improve docs in Factories
メンテナーはふだん 2 日以内に返信
評価
- 難易度
- 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
- 平均マージ
- 14日 10時間
- マージ済み PR（30日）
- 5
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
bcgit/bc-rust のほかの issue
-
good first issue refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
メンテナーはふだん 2 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
bcgit/bc-rust#163 · コメント 3 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
-
Refactor docs of SHA2 and SHA3 with respect to HMAC, HKDF再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンdocumentation good first issue refactor
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
element-hq/lk-jwt-service#248 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
pact-foundation/pact-cli#154 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
antithesishq/bombadil#361 ·
メンテナーはふだん 1 日以内に返信
-
test(executor_l0): assert execute() TaskOutcome, not only bus events / 断言 execute() 返回的 TaskOutcomeオープンtype:debt
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
skaiy/wild_agentos#425 ·
メンテナーはふだん 1 日以内に返信