Skip to content

Commit 157c93c

Browse files
committed
Update README and schema files for clarity and consistency in descriptions
1 parent 99378c1 commit 157c93c

File tree

4 files changed

+633
-530
lines changed

4 files changed

+633
-530
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,20 @@ Feedback and consensus are encouraged, but the maintainer makes final decisions
167167

168168
---
169169

170+
## Building Integrations
171+
172+
CTRF welcomes community-built integrations.
173+
174+
Integrations can be built independently and hosted in your own repositories. When ready, you can submit your integration to be listed on [ctrf.io/integrations](https://ctrf.io/integrations).
175+
176+
For guidance on building integrations:
177+
178+
- Follow the [reference implementation](https://github.com/ctrf-io/ctrf-js) for best practices
179+
- Ensure your integration produces valid CTRF output
180+
- Open a discussion if you need design feedback
181+
182+
---
183+
170184
## Code of Conduct
171185

172186
All contributors are expected to engage respectfully.

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Common Test Report Format
22

3-
**The open standard for test reporting.**
3+
**An open standard for test reporting.**
44

55
CTRF provides a unified JSON format for test outcomes that works across all languages and frameworks.
66

@@ -20,6 +20,15 @@ By standardizing the output of test execution, it enables results to be shared,
2020

2121
You can support the project by giving this repository a star ⭐
2222

23+
## Open Standard
24+
25+
CTRF is an open standard built and shaped by community contributions.
26+
27+
Your feedback and contributions are essential to the project's success:
28+
29+
- [Contribute](CONTRIBUTING.md)
30+
- [Discuss](https://github.com/orgs/ctrf-io/discussions)
31+
2332
## Schema
2433

2534
The schema is defined in [`schema/ctrf.schema.json`](schema/ctrf.schema.json).
@@ -36,6 +45,8 @@ The written specification defines the semantics and rules.
3645

3746
CTRF follows Semantic Versioning.
3847

48+
Releases are defined in [Releases](https://github.com/ctrf-io/ctrf/releases).
49+
3950
## Reference Implementation
4051

4152
The reference implementation, written in TypeScript, provides utilities for working with CTRF reports and is maintained alongside the specification. It serves as the canonical guide for implementing CTRF in any language.

schema/ctrf.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"title": "CTRF Report",
4-
"description": "Common Test Report Format - a standardized JSON format for test execution results",
3+
"title": "CTRF JSON Schema",
4+
"description": "Common Test Report Format - an open standard JSON format for test results reports",
55
"type": "object",
66
"required": [ "results", "reportFormat", "specVersion" ],
77
"properties": {

0 commit comments

Comments
 (0)