Skip to content

Commit 54e7f15

Browse files
committed
Migrate templates to forms
1 parent f191a30 commit 54e7f15

File tree

4 files changed

+168
-74
lines changed

4 files changed

+168
-74
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: There's no existing/similar bug report.
8+
description: Please search to see if an issue already exists for the bug you encountered.
9+
options:
10+
- label: I have searched the existing issues
11+
validations:
12+
required: true
13+
14+
- type: checkboxes
15+
attributes:
16+
label: This report is about a single actionable bug.
17+
description: Please create one issue per bug, split up your bug reports if needed.
18+
options:
19+
- label: I'm reporting a single actionable bug
20+
validations:
21+
required: true
22+
23+
- type: checkboxes
24+
attributes:
25+
label: This report is about the ProGit book, version 2, English language.
26+
description: Bug reports about translations or the first version of the book are not accepted.
27+
options:
28+
- label: This bug is not about a translation or old version
29+
validations:
30+
required: true
31+
32+
- type: checkboxes
33+
attributes:
34+
label: Bug covers book website/pdf
35+
description: This bug is about the book as found on the [website](https://www.git-scm.com/book/en/v2) or the PDF.
36+
options:
37+
- label: I confirm the bug is about the book as found on the website/pdf
38+
validations:
39+
required: false
40+
41+
- type: checkboxes
42+
attributes:
43+
label: Problem is present in the Pro Git book on the website?
44+
description: If you found an issue in the pdf/epub/mobi files, you've checked if the problem is also present in the Pro Git book on the [website](https://www.git-scm.com/book/en/v2).
45+
options:
46+
- label: This bug also affects the Pro Git book as published on the website.
47+
validations:
48+
required: false
49+
50+
- type: dropdown
51+
attributes:
52+
label: Which version of the book is affected?
53+
description: |
54+
It's important for us to know if the problem is in the source or in the tooling that creates the pdf/epub/mobi files.
55+
Therefore, please select which versions are affected.
56+
options:
57+
- "Source files"
58+
- "Tooling"
59+
- "Source files and tooling"
60+
- "I don't know"
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
attributes:
66+
label: "Describe the bug:"
67+
description: A clear and concise description of what the bug is.
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: "Steps to reproduce:"
74+
description: Please write the steps needed to reproduce the bug here.
75+
placeholder: Provide a ordered list of steps to reproduce.
76+
value: |
77+
1. Go to '...'
78+
2. Click on '...'
79+
3. 'Scroll down to '...'
80+
4. See error
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: "Expected behavior:"
87+
description: A clear and concise description of what you expected to happen.
88+
placeholder: I expected ... to happen.
89+
validations:
90+
required: true
91+
92+
- type: textarea
93+
attributes:
94+
label: "Screenshots:"
95+
description: If applicable, add screenshots to help explain your problem.
96+
placeholder: "Tip: you can drag your screenshot into this field, or you can copy/paste."
97+
validations:
98+
required: false
99+
100+
- type: textarea
101+
attributes:
102+
label: "Additional context:"
103+
description: |
104+
Add any other context about the problem here.
105+
You can also put references to similar bugs here.
106+
placeholder: "Example: this bug also affect issues #1 and #2."
107+
validations:
108+
required: false
109+
110+
- type: input
111+
attributes:
112+
label: Device
113+
description: Tell us what kind of device you're using to access the content.
114+
placeholder: mobile device / desktop / laptop / e-book reader
115+
validations:
116+
required: false
117+
118+
- type: input
119+
attributes:
120+
label: Operating system
121+
description: If the problem is with the book or the published files, we need to know what operating system you run on your device.
122+
placeholder: |
123+
Windows 10 Home Edition
124+
validations:
125+
required: false
126+
127+
- type: input
128+
attributes:
129+
label: Browser/application + version
130+
description: What browser/application are you using? We also need the version number of the browser/application.
131+
placeholder: |
132+
Google Chrome 91.0.4472.164
133+
validations:
134+
required: false

.github/ISSUE_TEMPLATE/enhancement_idea.md

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Enhancement idea
2+
description: Suggest an idea for the ProGit2 book or repository
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: General overview of your idea.
8+
description: Give a general overview of your idea.
9+
validations:
10+
required: true
11+
12+
- type: textarea
13+
attributes:
14+
label: What problem will this solve?
15+
description: Explain what problem you're trying to solve.
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Have you thought about other solutions?
22+
description: Describe any alternative solutions to the problem.
23+
validations:
24+
required: false
25+
26+
- type: dropdown
27+
attributes:
28+
label: Do you want to help with this enhancement idea?
29+
options:
30+
- "Yes"
31+
- "Maybe"
32+
- "No"
33+
validations:
34+
required: true

0 commit comments

Comments
 (0)