Skip to content

Commit c0a9274

Browse files
committed
chore: github issue template
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
1 parent f3a4cd5 commit c0a9274

File tree

4 files changed

+176
-0
lines changed

4 files changed

+176
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Bug Report
3+
description: Report a bug
4+
labels:
5+
- kind/bug
6+
- status/triage
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thank you for taking the time to report a bug!
13+
If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com).
14+
15+
- type: checkboxes
16+
attributes:
17+
label: Contributing guidelines
18+
description: |
19+
Please read the contributing guidelines before proceeding.
20+
options:
21+
- label: I've read the [contributing guidelines](https://github.com/docker/buildx/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree
22+
required: true
23+
24+
- type: checkboxes
25+
attributes:
26+
label: I've found a bug and checked that ...
27+
description: |
28+
Make sure that your request fulfills all of the following requirements.
29+
If one requirement cannot be satisfied, explain in detail why.
30+
options:
31+
- label: ... the documentation does not mention anything about my problem
32+
- label: ... there are no open or closed issues that are related to my problem
33+
34+
- type: textarea
35+
attributes:
36+
label: Description
37+
description: |
38+
Please provide a brief description of the bug in 1-2 sentences.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: Expected behaviour
45+
description: |
46+
Please describe precisely what you'd expect to happen.
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
attributes:
52+
label: Actual behaviour
53+
description: |
54+
Please describe precisely what is actually happening.
55+
validations:
56+
required: true
57+
58+
- type: input
59+
attributes:
60+
label: Buildx version
61+
description: |
62+
Can be found using the `docker buildx version` command.
63+
Example: `github.com/docker/buildx v0.8.1 5fac64c2c49dae1320f2b51f1a899ca451935554`
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
attributes:
69+
label: Docker info
70+
description: |
71+
Output of `docker info`.
72+
placeholder: |
73+
```
74+
75+
```
76+
render: markdown
77+
78+
- type: textarea
79+
attributes:
80+
label: Builders list
81+
description: |
82+
Output of `docker buildx ls`.
83+
placeholder: |
84+
```
85+
86+
```
87+
render: markdown
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
attributes:
93+
label: Configuration
94+
description: |
95+
Please provide a minimal Dockerfile, bake definition (if applicable) and invoked command to reproduce the bug.
96+
placeholder: |
97+
```dockerfile
98+
FROM alpine
99+
echo hello
100+
```
101+
102+
```hcl
103+
group "default" {
104+
targets = ["app"]
105+
}
106+
target "app" {
107+
dockerfile = "Dockerfile"
108+
target = "build"
109+
}
110+
```
111+
112+
```console
113+
$ docker buildx build .
114+
$ docker buildx bake
115+
```
116+
render: markdown
117+
validations:
118+
required: true
119+
120+
- type: textarea
121+
attributes:
122+
label: Logs
123+
description: |
124+
Please provide Buildx logs (also BuildKit logs if applicable).
125+
placeholder: |
126+
```
127+
128+
```
129+
render: markdown
130+
validations:
131+
required: false
132+
133+
- type: textarea
134+
attributes:
135+
label: Additional info
136+
description: |
137+
Please provide any additional information that could be useful.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Questions and Discussions
5+
url: https://github.com/docker/buildx/discussions/new
6+
about: Use Github Discussions to ask questions and/or open discussion topics.
7+
- name: Command line reference
8+
url: https://docs.docker.com/engine/reference/commandline/buildx/
9+
about: Read the command line reference.
10+
- name: Documentation
11+
url: https://docs.docker.com/build/
12+
about: Read the documentation.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Feature request
3+
description: Missing functionality? Come tell us about it!
4+
labels:
5+
- kind/enhancement
6+
- status/triage
7+
8+
body:
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What is the feature you want to see?
14+
validations:
15+
required: true

.github/SECURITY.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Reporting security issues
2+
3+
The project maintainers take security seriously. If you discover a security
4+
issue, please bring it to their attention right away!
5+
6+
**Please _DO NOT_ file a public issue**, instead send your report privately to
7+
[security@docker.com](mailto:security@docker.com).
8+
9+
Security reports are greatly appreciated, and we will publicly thank you for it.
10+
We also like to send gifts&mdash;if you're into schwag, make sure to let
11+
us know. We currently do not offer a paid security bounty program, but are not
12+
ruling it out in the future.

0 commit comments

Comments
 (0)