CTRF 0.3.0 preparation

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

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
json
Ambito
documentation

Direzione di ricerca

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.

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

Descrizione

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.

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

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.