Skip to content

Commit 0e9cb44

Browse files
authored
Add issue template (pointfreeco#4)
1 parent 50eb7b1 commit 0e9cb44

File tree

3 files changed

+90
-2
lines changed

3 files changed

+90
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for contributing to Perception!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: |
15+
A short description of the incorrect behavior.
16+
17+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
25+
required: false
26+
- label: If possible, I've reproduced the issue using the `main` branch of this package.
27+
required: false
28+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/pointfreeco/swift-perception/issues) or [discussion](https://github.com/pointfreeco/swift-perception/discussions).
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Expected behavior
33+
description: Describe what you expected to happen.
34+
validations:
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Actual behavior
39+
description: Describe or copy/paste the behavior you observe.
40+
validations:
41+
required: false
42+
- type: textarea
43+
attributes:
44+
label: Steps to reproduce
45+
description: |
46+
Explanation of how to reproduce the incorrect behavior.
47+
48+
This could include an attached project or link to code that is exhibiting the issue, and/or a screen recording.
49+
placeholder: |
50+
1. ...
51+
validations:
52+
required: false
53+
- type: input
54+
attributes:
55+
label: Perception version information
56+
description: The version of Perception used to reproduce this issue.
57+
placeholder: "'1.0.0' for example, or a commit hash"
58+
- type: input
59+
attributes:
60+
label: Destination operating system
61+
description: The OS running your application.
62+
placeholder: "'iOS 13' for example"
63+
- type: input
64+
attributes:
65+
label: Xcode version information
66+
description: The version of Xcode used to reproduce this issue.
67+
placeholder: "The version displayed from 'Xcode 〉About Xcode'"
68+
- type: textarea
69+
attributes:
70+
label: Swift Compiler version information
71+
description: The version of Swift used to reproduce this issue.
72+
placeholder: Output from 'xcrun swiftc --version'
73+
render: shell

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Project Discussion
5+
url: https://github.com/pointfreeco/swift-perception/discussions
6+
about: Perception Q&A, ideas, and more
7+
- name: Documentation
8+
url: https://pointfreeco.github.io/swift-perception/main/documentation/perception/
9+
about: Read Perception's documentation
10+
- name: Videos
11+
url: https://www.pointfree.co/
12+
about: Watch videos to get a behind-the-scenes look at how this library and others were motivated and built
13+
- name: Slack
14+
url: https://www.pointfree.co/slack-invite
15+
about: Community chat

Sources/Perception/WithPerceptionTracking.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ public enum _PerceptionLocals {
3838
/// }
3939
/// ```
4040
///
41-
/// If a field of a `@Percetible` model is accessed in a view while _not_ inside
41+
/// If a field of a `@Perceptible` model is accessed in a view while _not_ inside
4242
/// ``WithPerceptionTracking``, then a runtime warning will helpfully be triggered:
4343
///
4444
/// > 🟣 Runtime Warning: Perceptible state was accessed but is not being tracked. Track changes to
45-
/// state by wrapping your view in a 'WithPerceptionTracking' view.
45+
/// > state by wrapping your view in a 'WithPerceptionTracking' view.
4646
///
4747
/// To debug this, expand the warning in the Issue Navigator of Xcode (cmd+5), and click through the
4848
/// stack frames displayed to find the line in your view where you are accessing state without being

0 commit comments

Comments
 (0)