1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
# Swift Testing documentation
<!--
This source file is part of the Swift.org open source project
Copyright (c) 2024 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
-->
## API and usage guides
The detailed documentation for Swift Testing can be found on the
[Swift Package Index](https://swiftpackageindex.com/swiftlang/swift-testing/main/documentation/testing).
There, you can delve into comprehensive guides, tutorials, and API references to
make the most out of this package.
This documentation is generated using [DocC](https://github.com/swiftlang/swift-docc)
and is derived from symbol documentation in this project's source code as well
as supplemental content located in the
[`Sources/Testing/Testing.docc/`](https://github.com/swiftlang/swift-testing/tree/main/Sources/Testing/Testing.docc)
directory.
## Vision document
The [Vision document](https://github.com/swiftlang/swift-evolution/blob/main/visions/swift-testing.md)
for Swift Testing offers a comprehensive discussion of the project's design
principles and goals.
## Development and contribution
- The top-level [`README`](https://github.com/swiftlang/swift-testing/blob/main/README.md)
gives a high-level overview of the project, shows current CI status, lists the
support status of various platforms, and more.
- [Contributing](https://github.com/swiftlang/swift-testing/blob/main/CONTRIBUTING.md)
provides guidance for developing and making project contributions.
- [Style Guide](https://github.com/swiftlang/swift-testing/blob/main/Documentation/StyleGuide.md)
describes this project's guidelines for code and documentation style.
- [SPI groups in Swift Testing](https://github.com/swiftlang/swift-testing/blob/main/Documentation/SPI.md)
describes when and how the testing library uses Swift SPI.
## Project maintenance
- The [Releases](https://github.com/swiftlang/swift-testing/blob/main/Documentation/Releases.md)
document describes the process of creating and publishing a new release of
Swift Testing — a task which may be performed by project administrators.
|
