Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Proposal: Schedule `results.tests[].id` for Removement Before CTRF Release 1.0.0

Đang mở
  • Có gì không ổn?
#72 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
32/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
json
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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. id is deprecated and scheduled for removement. Producers SHALL use/switch to testId (Section 9.2).

Description:
A unique, stable identifier for the test case.

Requirements:
id is OPTIONAL.
If present, it MUST be a valid UUID as defined in [RFC4122].

Deprecation Notice:
For producers id is scheduled for removement with CTRF version 1.0.0.
New producer implementations MUST use testId instead of id from beginning.
Existing producers implementations SHALL switch from id to testId before CTRF version 1.0.0.
Consumers may support id beyond CTRF version 1.0.0 as follows for CTRF versions < 1.0.0:
When both id and testId are present, consumers SHALL use testId.

I do not understand the intention behind:

Consumers SHOULD treat id as 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?

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
99
Fork
4
Merge trung bình
1 giờ 21 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ctrf-io/ctrf

Tất cả issue của ctrf-io/ctrf

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.