Proposal: Schedule `results.tests[].id` for Removement Before CTRF Release 1.0.0
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 半日
- 初心者へのやさしさ
- 32/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- json
調査の方向性
The change belongs in the spec text for section 9.1 (id) of the CTRF specification, which should point to section 9.2 (testId). Read the deprecation notice and the sentence about consumers treating id as legacy, then settle that sentence with the maintainers before editing. Done means the agreed wording is merged and the 1.0.0 removal date is stated consistently.
索引モデルが issue の本文から書いたものです。
説明
I propose to document the removement of results.tests[].id with the release of CTRF version 1.0.0 latest.
The goal is to avoid starting with a legacy in the first CTRF version.
Below is my preliminary draft proposal for updating the documentation to apply some pressure and make it clear that id will be removed by version 1.0.0 at the latest.
9.1. id
Legacy.
idis deprecated and scheduled for removement. Producers SHALL use/switch totestId(Section 9.2).Description:
A unique, stable identifier for the test case.Requirements:
idis OPTIONAL.
If present, it MUST be a valid UUID as defined in [RFC4122].Deprecation Notice:
For producersidis scheduled for removement with CTRF version 1.0.0.
New producer implementations MUST usetestIdinstead ofidfrom beginning.
Existing producers implementations SHALL switch fromidtotestIdbefore CTRF version 1.0.0.
Consumers may supportidbeyond CTRF version 1.0.0 as follows for CTRF versions < 1.0.0:
When bothidandtestIdare present, consumers SHALL usetestId.
I do not understand the intention behind:
Consumers SHOULD treat
idas legacy unless a producer documents stronger semantics.
So I felt free to just remove this sentence :-).
P.S.: Of course, the wording suggested above is a pre-1.0 wording.
For version 1.0.0 it will then need to be reworded accordingly.
What do you think about this?
- 主要言語
- 言語のデータがありません
- スター
- 99
- フォーク
- 4
- 平均マージ
- 1時間 21分
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ctrf-io/ctrf のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
-
難易度 4/5 1〜2日 初心者へのやさしさ 48/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
似ている issue
-
docs help wanted
難易度 1/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
MattA-Official/vwmcp#20 ·
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
cosimochellini/one-piece-zero-spoiler#551 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
undergroundrap/hatchling#15 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Albert-Weasker/niubigeo#205 ·
メンテナーはふだん 1 日以内に返信