CTRF 0.3.0 preparation

未关闭
#75 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
json
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
没有语言数据
星标
103
派生
4
平均合并
1 小时 3 分钟
30 天内合并 PR
2

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ctrf-io/ctrf 的其他 Issue

查看 ctrf-io/ctrf 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。