Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#72 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
32/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
json
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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?

Lingua principale
Nessun dato sulla lingua
Stelle
99
Fork
4
Merge medio
1h 21m
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ctrf-io/ctrf

Tutte le issue di ctrf-io/ctrf

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.