Autogen per-test docs for discoverability
メンテナーはふだん 14 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- go, yaml
- 領域
- documentation, testing
調査の方向性
まず、提案されている YAML スキーマと、エントリーポイントの例である tests/csapi/rooms_state_test.go:TestRoomCreationReportsEventsToMyself を調べます。自動ドキュメント作成のために、sytests が名前、動作、バリアント、テスト領域をどのように公開しているかを確認します。生成されたドキュメントでそれらの詳細を一覧化し、各エントリをテストパスにリンクできれば完了です。
索引モデルが issue の本文から書いたものです。
説明
While working on importing sytests, i found myself ctrl-shift-f-ing on keywords to see what tests already existed to see if a sytest would fit that file, however, I think that this displays some poor test discoverability.
However, when i was documenting some sytests (and their behaviour), i came upon something like the following format;
sytest:
- name: "Non-present room members cannot ban others"
type:
- power_level
- ban
desc:
When a user does not exist in a room, but has powerlevels there, it should not be able to ban users.
variants:
- user has never entered the room
- user has left the room
- user has been kicked while ban is sent out
- user server has been ACL-d
- name: "New federated private chats get full presence information (SYN-115)"
# ...
I think it would be useful to programmatically document (and maybe link) these tests, so that a quick glance can see which ones exist, what it does, what variants of behaviour it's also testing, and also in which "areas" of testing matrix it exists.
For a final variant of above schema, i think adding a path (something like tests/csapi/rooms_state_test.go:TestRoomCreationReportsEventsToMyself) would help auto-identify the corresponding function.
- 主要言語
- Go
- スター
- 101
- フォーク
- 72
- 平均マージ
- 11日 5時間
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
matrix-org/complement のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
matrix-org/complement#900 · コメント 1 件 ·
メンテナーはふだん 14 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
matrix-org/complement#938 ·
メンテナーはふだん 14 日以内に返信
-
New tests for MSC4354 Sticky Events再び着手できるかも @reivilibre が 32 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
matrix-org/complement#925 · 担当者 1 名 ·
メンテナーはふだん 14 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
matrix-org/complement#901 · コメント 1 件 ·
メンテナーはふだん 14 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
matrix-org/complement#899 ·
メンテナーはふだん 14 日以内に返信
matrix-org/complement の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
[flaky test] TestValidatorCommitterDropsEmptyStatusBatch: submits to the mock VC before its stream is registered対応中かも @liran-funaro が今日担当しました。 オープンcoordinator flaky-test race-condition testing
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
hyperledger/fabric-x-committer#876 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
garethgeorge/backrest#1426 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 1 日以内に返信
-
enhancement nav-pilot
難易度 2/5 半日 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信