Skip to content

Commit 8e703e2

Browse files
sethladddevoncarew
andauthored
Update README.md to clarify this is an experiment (#2512)
Co-authored-by: Devon Carew <[email protected]>
1 parent 0793a2b commit 8e703e2

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

pkgs/checks/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- Fix a bug where printing the result of a failed deep quality check would
1212
fail with a `TypeError` when comparing large `Map` instances
1313
- Increase SDK constraint to ^3.5.0.
14+
- Clarify this package is an _experiment_
1415

1516
## 0.3.0
1617

pkgs/checks/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,21 @@
44
`package:checks` is a library for expressing test expectations and it features
55
a literate API.
66

7-
## package:checks preview
7+
## package:checks (experimental)
88

9-
`package:checks` is in preview; to provide feedback on the API, please file
9+
`package:checks` is an experiment. For production use cases, please
10+
use `package:test` and `package:matcher`.
11+
12+
For packages in the labs.dart.dev publisher we generally plan to either graduate the
13+
package into a supported publisher (dart.dev, tools.dart.dev) after a period of
14+
feedback and iteration, or discontinue the package. These packages have a much
15+
higher expected rate of API and breaking changes.
16+
17+
To provide feedback on the API, please file
1018
[an issue][] with questions, suggestions, feature requests, or general
1119
feedback.
1220

13-
For documentation about migrating from `package:matcher` to `checks`, see the
21+
For documentation about converting your usage of `package:matcher` to `checks`, see the
1422
[migration guide][].
1523

1624
[an issue]:https://github.com/dart-lang/test/issues/new?labels=package%3Achecks&template=03_checks_feedback.md

0 commit comments

Comments
 (0)