Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#72 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
32/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
json
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?

Lenguaje dominante
Sin datos de lenguaje
Estrellas
98
Forks
4
Merge medio
1 h 21 min
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ctrf-io/ctrf

Todos los issues de ctrf-io/ctrf

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.