Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2025 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

name: 🪲 Report a bug
description: >
Report a deviation from expected or documented behavior.
labels: [bug, triage-needed]
body:
- type: markdown
attributes:
value: >
This repository hosts the Swift Testing library and its documentation.
It does _not_ track feedback for Xcode and other closed source Apple
developer software such as XCTest; please direct that to
[Feedback Assistant](https://developer.apple.com/bug-reporting) instead.
- type: textarea
attributes:
label: Description
description: >
A concise description of what causes the problem, in human language.
Though not required, it may help us to more accurately triage the issue
as well as understand a non-trivial test case.
validations:
required: false
- type: textarea
attributes:
label: Reproduction
description: >
Provide an example, preferably in a Markdown code block, and explain how
to build or run it to reproduce the problem. If the problem is a poor or
unexpected diagnostic, fix-it, or other output, please show this output
as is. For example, paste it from the terminal. Consider reducing the
example to the smallest amount of code possible — a smaller example is
easier to reason about and more appealing to contributors.
value: |
```swift

```
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: Describe the behavior you expected.
validations:
required: true
- type: textarea
attributes:
label: Environment
description: >
Provide details about the environment in which this problem occurs.
Include the versions of Swift Testing and the Swift toolchain. If you
suspect the problem might be specific to a particular platform, please
specify the platform and OS version as well.
placeholder: |
Swift Testing version: (shown in `swift test` output)
$ swift --version
$ uname -a
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: >
Any complementary information that could help others to work around the
problem, and us to better understand the problem and its impact. For
example, a link to a discussion or post that motivated this report.
validations:
required: false
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/02-change-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2025 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

name: 🌟 Request a change
description: >
Request a feature, API, improvement, or other change.
labels: [enhancement, triage-needed]
body:
- type: markdown
attributes:
value: >
This repository hosts the Swift Testing library and its documentation.
It does _not_ track feedback for Xcode and other closed source Apple
developer software such as XCTest; please direct that to
[Feedback Assistant](https://developer.apple.com/bug-reporting) instead.

___

Swift Testing is guided by a community-driven evolution process.
Submitting this form is not a guarantee that the request will be
considered or implemented. If the request implies an addition, removal,
or change to the features of Swift Testing or its public interfaces,
please consider socializing it on the
[Swift forums](https://forums.swift.org/c/related-projects/swift-testing)
instead. The Swift forums are the preferred space for sharing ideas and
discussing them with the Swift community.
- type: textarea
attributes:
label: Motivation
description: >
Describe the problems that this idea seeks to address. If the problem is
that some common pattern is currently hard to express, show how one can
currently get a similar effect and describe its drawbacks. If it's
completely new functionality that cannot be emulated, motivate why this
new functionality would help create better Swift tests.
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: >
Describe the proposed solution to the problem. Provide examples and
describe how they work. Show how this solution is better than current
workarounds: is it cleaner, safer, or more efficient?
validations:
required: true
- type: textarea
attributes:
label: Alternatives considered
description: >
Any alternative approaches that were considered, and why the _proposed
solution_ was chosen instead.
validations:
required: false
- type: textarea
attributes:
label: Additional information
description: >
Any complementary information that could be valuable to an author of a
formal proposal, an implementor, or future discussions. For example, a
link to a discussion or post that motivated this request.
validations:
required: false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/03-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2025 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

name: ⚙️ Track a task
description: >
Tasks can be used to track internal work, extract individual subtasks from a
larger issue, or can serve as umbrella issues themselves.
labels: []
body:
- type: markdown
attributes:
value: >
This repository hosts the Swift Testing library and its documentation.
It does _not_ track feedback for Xcode and other closed source Apple
developer software such as XCTest; please direct that to
[Feedback Assistant](https://developer.apple.com/bug-reporting) instead.
- type: textarea
attributes:
label: Description
description: >
A comprehensive description of the task, in human language.
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: >
Any complementary information that could be valuable to an implementor.
For example, a link to a discussion or post that motivated this task.
validations:
required: false
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml

This file was deleted.

39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2025 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

blank_issues_enabled: true
contact_links:
- name: 🌐 Discuss an idea
url: https://forums.swift.org/c/related-projects/swift-testing
about: >
Share an idea with the Swift Testing community.
- name: 📄 Formally propose a change
url: https://github.com/swiftlang/swift-testing/blob/main/Documentation/Proposals/0000-proposal-template.md
about: >
Formally propose an addition, removal, or change to the APIs or features
of Swift Testing.
- name: 🙋 Ask a question
url: https://forums.swift.org/c/related-projects/swift-testing
about: >
Ask a question about or get help with Swift Testing. Beginner questions
welcome!
- name: 🪲 Report an issue with Swift Package Manager
url: https://github.com/swiftlang/swift-package-manager/issues/new/choose
about: >
Report an issue with Swift Package Manager, which includes the
"swift test" CLI tool.
- name: 🪲 Report an issue with Apple software using Feedback Assistant
url: https://developer.apple.com/bug-reporting
about: >
Report an issue with Xcode or other closed source Apple developer
software such as XCTest.
- name: 🪲 Report an issue with the VS Code Swift plugin
url: https://github.com/swiftlang/vscode-swift/issues/new/choose
about: >
Report an issue with the Swift plugin for VS Code, which integrates with
Swift Testing.
- name: 📖 Learn about Swift Testing
url: https://swiftpackageindex.com/swiftlang/swift-testing/main/documentation/testing
about: >
Read the official Swift Testing documentation.