CTRF 0.3.0 preparation

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

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
json
Área
documentation

Línea de trabajo

Start by reviewing draft PR #76 against main, then assess each subsequent draft PR against its stated base in dependency order. Readiness also calls for schema formatting/lint, reference and normative suites, example validity, and embedded/standalone schema synchronization on the final candidate. Done means the 0.3.0 scope and outstanding design decisions are settled, the drafts are assessed, and release readiness is verified; merges and publication require separate authorization.

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

Descripción

Prepare and assess the next CTRF specification release through focused, stacked draft PRs. This issue tracks proposed scope and review readiness; it is not a release announcement.

Proposed changes

  • Clarify deterministic UUID guidance for test identifiers.
  • Clarify test-case terminology and parameterized cases.
  • Clarify case identity and coordinated retry execution identity.
  • Add coordinated raw, retry and merged report examples.
  • Clarify portable attachment references and producer-defined digest metadata.
  • Document planned legacy id removal in 1.0.0 while retaining current acceptance.
  • Clarify captured output lines and valid empty/omitted output.
  • Add optional Test description.
  • Align specification and example/fixture version metadata for 0.3.0.

The draft PRs will form a stack: the first targets main, and each later PR targets the preceding branch. Review each PR against its stated base. Merge in dependency order only after assessment; retarget/update each dependent PR as its parent lands. Original discussion references will be added after the changes have been assessed.

Draft PR stack

Order Draft Base
1 #76 — Clarify deterministic UUID guidance for test identifiers main
2 #77 — Clarify test case terminology and parameterized cases prep/0.3.0-01-uuid-guidance
3 #78 — Clarify case identity and coordinated retry executions prep/0.3.0-02-test-case-terminology
4 #79 — Illustrate coordinated retry reports and logical run identity prep/0.3.0-03-case-and-execution-identity
5 #80 — Clarify portable attachment references and digest metadata prep/0.3.0-04-coordinated-run-examples
6 #81 — Document legacy test identifier removal in CTRF 1.0.0 prep/0.3.0-05-attachment-guidance
7 #82 — Clarify captured output lines and empty output prep/0.3.0-06-id-deprecation
8 #83 — Add optional test case description prep/0.3.0-07-output-lines
9 #84 — Prepare CTRF specification 0.3.0 version metadata prep/0.3.0-08-test-description

Additional scope and decisions

  • Retry-history worker identity is being handled separately by @alexshamrai, it is not implemented in this stack currently.
  • Optional first-class assertion data is agreed in principle. Its collection shape, value types, missing-value rules and final/history placement still need a contract decision before implementation.

Readiness

  • Assess each draft and settle the intended 0.3.0 scope.
  • Resolve any selected assertion design before adding implementation.
  • Integrate the separately contributed worker-identity change after review.
  • Verify schema formatting/lint, reference/normative suites, example validity and embedded/standalone schema synchronization on the final candidate.
  • Finalize the version date and release changelog after scope is settled.
  • Plan and verify library, standalone CLI, reporter/consumer and website adoption, including both generated references.
  • Review and authorize merges and publication separately.

Specification versions and package versions are independent. Optional reporter population can be tracked separately; target-version output must still be valid.

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

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.