Skip to content

Commit a8eb411

Browse files
authored
Add a review proposal announcement template for Swift Testing to process documentation (#2842)
1 parent cc662fd commit a8eb411

File tree

1 file changed

+76
-4
lines changed

1 file changed

+76
-4
lines changed

process.md

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ A given proposal can be in one of several states:
241241

242242
[swift-evolution-repo]: https://github.com/swiftlang/swift-evolution "Swift evolution repository"
243243
[swift-evolution-staging]: https://github.com/swiftlang/swift-evolution-staging "Swift evolution staging repository"
244-
[proposal-reviews]: https://forums.swift.org/c/evolution/proposal-reviews "'Proposal reviews' category of the Swift forums"
244+
[proposal-reviews]: https://forums.swift.org/c/evolution/proposal-reviews "'Proposal reviews' subcategory of the Swift forums"
245245
[status-page]: https://www.swift.org/swift-evolution
246246
[preview-package]: https://github.com/apple/swift-standard-library-preview/
247247
[language-steering-group]: https://www.swift.org/language-steering-group
@@ -253,11 +253,15 @@ A given proposal can be in one of several states:
253253

254254
## Review announcement
255255

256-
When a proposal enters review, a new topic will be posted to the ["Proposal Reviews" section of the Swift forums][proposal-reviews]
257-
using the following template:
256+
When a proposal enters review, a new topic will be posted to the
257+
["Proposal Reviews" subcategory of the Swift forums][proposal-reviews] using the
258+
relevant announcement template below:
258259

259260
---
260261

262+
<details open>
263+
<summary>Swift language, compiler, and standard library</summary>
264+
261265
Hello Swift community,
262266

263267
The review of "\<\<PROPOSAL NAME>>" begins now and runs through \<\<REVIEW
@@ -297,4 +301,72 @@ Thank you,
297301

298302
Review Manager
299303

300-
---
304+
</details>
305+
306+
<details>
307+
<summary>Swift Testing public interfaces and features</summary>
308+
309+
Hello Swift community,
310+
311+
The review of "\<\<PROPOSAL NAME>>" begins now and runs through \<\<REVIEW END DATE>>.
312+
The proposal is available here:
313+
314+
> https://linkToProposal
315+
316+
Reviews are an important part of the Swift evolution process. All review
317+
feedback should be either on this forum thread or, if you would like to keep
318+
your feedback private, directly to the review manager. When emailing the review
319+
manager directly, please keep the proposal link at the top of the message.
320+
321+
##### Trying it out
322+
323+
To try this feature out, add a dependency to the `main` branch of
324+
`swift-testing` to your package:
325+
326+
```swift
327+
dependencies: [
328+
...
329+
.package(url: "https://github.com/swiftlang/swift-testing.git", branch: "main"),
330+
]
331+
```
332+
333+
Then, add a target dependency to your test target:
334+
335+
```swift
336+
.testTarget(
337+
...
338+
dependencies: [
339+
...
340+
.product(name: "Testing", package: "swift-testing"),
341+
]
342+
```
343+
344+
Finally, import Swift Testing using `@_spi(Experimental) import Testing`.
345+
346+
##### What goes into a review?
347+
348+
The goal of the review process is to improve the proposal under review through
349+
constructive criticism and, eventually, determine the direction of Swift. When
350+
writing your review, here are some questions you might want to answer in your
351+
review:
352+
353+
* What is your evaluation of the proposal?
354+
* Is the problem being addressed significant enough to warrant a change to Swift
355+
Testing?
356+
* Does this proposal fit well with the feel and direction of Swift Testing?
357+
* If you have used other languages or libraries with a similar feature, how do
358+
you feel that this proposal compares to those?
359+
* How much effort did you put into your review? A glance, a quick reading, or an
360+
in-depth study?
361+
362+
More information about the Swift evolution process is available at
363+
364+
> https://github.com/swiftlang/swift-evolution/blob/main/process.md
365+
366+
Thank you,
367+
368+
-\<\<REVIEW MANAGER NAME>>
369+
370+
Review Manager
371+
372+
</details>

0 commit comments

Comments
 (0)