Guidelines for documenting intended vs actual behavior
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- rust
調査の方向性
まず Rust Reference の authoring guide を見つけ、意図された動作と実際の動作を現在どのように扱っているかを確認します。既知のバグ、issue リンク、future-incompatible warnings、不明な意図に関する疑問を解決し、そのうえで合意した指針を guide に記載します。
索引モデルが issue の本文から書いたものです。
説明
I think the authoring guide should have some guidance on whether to document the actual behavior of rustc vs the intended behavior, and how to handle known bugs.
If there is a known issue, should it be encouraged or discouraged to link to the GitHub issue?
Should it have specific callouts for future-incompatible warnings? How should these known problems be documented? Should it document how it is intended to work? What if the intention is not yet known?
- 主要言語
- Rust
- スター
- 1.6k
- フォーク
- 611
- 平均マージ
- 1日 3時間
- マージ済み PR（30日）
- 9
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
rust-lang/reference のほかの issue
-
A-const-eval A-undefined-behavior
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
rust-lang/reference#2266 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
A-resolve
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
A-coercions
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
rust-lang/reference#2094 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
rust-lang/reference の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
RustCrypto/SSH#596 ·
-
proxy: SQL-over-HTTP turns empty arrays into [""] or [false], or HTTP 500 for int and float arraysオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
neondatabase/neon#12965 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
goauthentik/authentik#26867 ·
メンテナーはふだん 1 日以内に返信
-
api bug macos maintainer-needed p2 triaged
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
area::tern difficulty::easy good first issue kind::cleanup triage::ready
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100