docs: README, H2H3.md and an API reference for what 0.1 ships
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 42/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- c, markdown
調査の方向性
Start with README.md, where the 'server side only' status claim sits, and H2H3.md's 'Limits and simplifications' section, then compare both with the client functions h2_init_client, h3_init_client, quic_connect and quic_connect_resume in their headers. Done when every public function and struct field in those headers, plus fbresp.h, has documentation and the README status section matches the 0.1 release.
索引モデルが issue の本文から書いたものです。
説明
After the merges in the 0.1 milestone the docs no longer match the code:
- README.md says the HTTP/2, HTTP/3 and QUIC engines are "server side only".
- H2H3.md's "Limits and simplifications" still lists no 0-RTT, 0 QPACK blocked streams, no Retry or Version Negotiation on the client, and only curl and aioquic as real clients.
- The client APIs (
h2_init_client,h3_init_client,quic_connect,quic_connect_resume), the raw-QUIC interface from #50 (ALPN lists, server-opened streams, per-connection limits) andfbresp.hare documented only in header comments.
Needed:
- README and H2H3.md rewritten for what 0.1 actually ships, client and server, with the remaining limits stated plainly.
- An API reference per header: lifecycle, callbacks, ownership and buffer rules, error codes, and thread-safety (none: one connection, one thread).
- A short guide for each example: an HTTP/3 server, an HTTP/2 client, raw QUIC (
examples/quic_echo.c).
Done when: every public function and struct field is documented, and the README's status section matches the release.
- 主要言語
- C
- スター
- 0
- フォーク
- 0
- 平均マージ
- 20時間 4分
- マージ済み PR(30日)
- 25
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
public/cursed-http のほかの issue
-
P0: release blocker
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
public/cursed-http#56 ·
メンテナーはふだん 1 日以内に返信
-
P1: first release
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
public/cursed-http#61 ·
メンテナーはふだん 1 日以内に返信
-
P0: release blocker
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
public/cursed-http#60 ·
メンテナーはふだん 1 日以内に返信
-
P0: release blocker
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
public/cursed-http#58 ·
メンテナーはふだん 1 日以内に返信
-
P0: release blocker
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
public/cursed-http#57 ·
メンテナーはふだん 1 日以内に返信
public/cursed-http の issue をすべて見る
似ている issue
-
triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
xerial/sqlite-jdbc#1515 ·
メンテナーはふだん 1 日以内に返信
-
macOS 菜单栏托盘图标保留橙色,与系统单色图标风格不一致対応中かも @xhugoliu が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
YizhengWw/HachimoDock#56 · コメント 1 件 ·
-
compiler-rt:asan
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
llvm/llvm-project#242921 ·
メンテナーはふだん 1 日以内に返信
-
Missing gcc __builtin_stdc_bit_width/floor/ceil signature makes intellisense wrongly report error 70オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
microsoft/vscode-cpptools#14874 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
BasedHardware/omi#25431 ·
メンテナーはふだん 1 日以内に返信