Skip to content

Commit 3c0ec29

Browse files
committed
chore: materialize canonical issue forms
1 parent c0eba9e commit 3c0ec29

4 files changed

Lines changed: 126 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug report
2+
description: Report reproducible incorrect behavior in this repository.
3+
title: ""
4+
type: Bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Do not report security vulnerabilities here. Use the private security-reporting link in the template chooser.
10+
- type: textarea
11+
id: behavior
12+
attributes:
13+
label: Observed behavior
14+
description: What happened?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: expected
19+
attributes:
20+
label: Expected behavior
21+
description: What should have happened?
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reproduction
26+
attributes:
27+
label: Minimal reproduction
28+
description: Provide the smallest complete example and exact commands.
29+
render: swift
30+
validations:
31+
required: true
32+
- type: input
33+
id: swift
34+
attributes:
35+
label: Swift version
36+
placeholder: Output of swift --version
37+
validations:
38+
required: true
39+
- type: input
40+
id: platform
41+
attributes:
42+
label: Platform
43+
placeholder: Operating system, architecture, and relevant SDK
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: context
48+
attributes:
49+
label: Additional context
50+
description: Add logs, links, or constraints that help reproduce the problem.

.github/ISSUE_TEMPLATE/change.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Change request
2+
description: Propose a concrete change owned by this repository.
3+
title: ""
4+
type: Feature
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use the discussion hub for open-ended exploration. File this form when the requested outcome is actionable.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem
14+
description: What user or implementation problem needs to be solved?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: outcome
19+
attributes:
20+
label: Proposed outcome
21+
description: Describe the observable result, not only an implementation.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Alternatives considered
28+
description: What other approaches were evaluated?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: impact
33+
attributes:
34+
label: Compatibility and migration impact
35+
description: Identify affected APIs, packages, platforms, or adopters.
36+
validations:
37+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Report a security vulnerability
4+
url: https://github.com/swift-foundations/swift-pdf/security/advisories/new
5+
about: Privately report a vulnerability in this repository.
6+
- name: Questions, proposals, and research
7+
url: https://github.com/orgs/swift-institute/discussions
8+
about: Use the Institute discussion hub for non-actionable questions and early design work.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Documentation request
2+
description: Report missing, inaccurate, or unclear documentation.
3+
title: ""
4+
type: Task
5+
body:
6+
- type: textarea
7+
id: gap
8+
attributes:
9+
label: Documentation gap
10+
description: What is missing, inaccurate, or unclear?
11+
validations:
12+
required: true
13+
- type: input
14+
id: location
15+
attributes:
16+
label: Location
17+
description: Link to the affected README, DocC page, declaration, or example.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: proposed
22+
attributes:
23+
label: Proposed correction
24+
description: Describe the change and the reader outcome it should produce.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: evidence
29+
attributes:
30+
label: Supporting evidence
31+
description: Add source links, reproductions, or references that establish the correction.

0 commit comments

Comments
 (0)