Skip to content

Commit 5f7fe48

Browse files
Add issue templates for bugs and features (#152)
I would love feedback on how people feel about these issue templates, if there should be more or less templates, or if there are any fields that people think we should add. You can see an example of how to use these by testing opening an issue on my fork [here](https://github.com/katiewasnothere/container/issues). Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
1 parent 2327e89 commit 5f7fe48

File tree

3 files changed

+115
-0
lines changed

3 files changed

+115
-0
lines changed

.github/ISSUE_TEMPLATE/01-bug.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: checkboxes
11+
id: prereqs
12+
attributes:
13+
label: I have done the following
14+
description: Select that you have completed the following prerequisites.
15+
options:
16+
- label: I have searched the existing issues
17+
required: true
18+
- label: If possible, I've reproduced the issue using the 'main' branch of this project
19+
required: false
20+
- type: input
21+
id: contact
22+
attributes:
23+
label: Contact Details
24+
description: How can we get in touch with you if we need more info? ex. email@example.com
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: reproduce
29+
attributes:
30+
label: Steps to reproduce
31+
description: Explain how to reproduce the incorrect behavior.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: what-happened
36+
attributes:
37+
label: Current behavior
38+
description: A concise description of what you're experiencing.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: expected
43+
attributes:
44+
label: Expected Behavior
45+
description: A concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Environment
51+
description: |
52+
examples:
53+
- **OS**: MacOS 26 Beta 1
54+
- **swift**: Apple Swift version 6.2
55+
- **xcode**: Xcode 26 Beta 17A5241e
56+
- **container**: container CLI version 0.1.0
57+
value: |
58+
- OS:
59+
- swift:
60+
- xcode:
61+
- container:
62+
render: markdown
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: logs
67+
attributes:
68+
label: Relevant log output
69+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
70+
render: shell
71+
- type: checkboxes
72+
id: terms
73+
attributes:
74+
label: Code of Conduct
75+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/apple/container/blob/main/CONTRIBUTING.md).
76+
options:
77+
- label: I agree to follow this project's Code of Conduct
78+
required: true
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature or Enhancement request
2+
description: File a request for a feature or enhancement
3+
title: "[Request]: "
4+
labels: ["feature", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for contributing to the container project!
10+
- type: input
11+
id: contact
12+
attributes:
13+
label: Contact Details
14+
description: How can we get in touch with you if we need more info?
15+
placeholder: ex. email@example.com
16+
validations:
17+
required: false
18+
- type: textarea
19+
id: request
20+
attributes:
21+
label: Feature or enhancement request details
22+
description: Describe your proposed feature or enhancement. Code samples that show what's missing, or what new capabilities will be possible, are very helpful! Provide links to existing issues or external references/discussions, if appropriate.
23+
validations:
24+
required: true
25+
- type: checkboxes
26+
id: terms
27+
attributes:
28+
label: Code of Conduct
29+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).
30+
options:
31+
- label: I agree to follow this project's Code of Conduct
32+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: container community support
4+
url: https://github.com/apple/container/discussions
5+
about: Please ask and answer questions here.

0 commit comments

Comments
 (0)