Skip to content

Commit e315fdd

Browse files
committed
Add solutions to the template challenges
1 parent 7c6cc7d commit e315fdd

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

episodes/templates.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,34 @@ Finish the "Design Discussion" template by adding the following sections:
151151

152152
Then commit the changes directly to your main branch.
153153

154+
:::::::::::::::::::::: solution
155+
156+
The finished `design_discussion.md` combines the header from above with two Markdown sections.
157+
Wording will vary, but it should look something like:
158+
159+
```markdown
160+
---
161+
name: Design Discussion
162+
about: Start a design discussion for the project
163+
title: ''
164+
labels: ''
165+
assignees: ''
166+
167+
---
168+
169+
## Description
170+
171+
<!-- A clear description of the design question or proposal. -->
172+
173+
## Motivation
174+
175+
<!-- Why does this matter? What problem or use case does it address? -->
176+
```
177+
178+
After committing to `main`, the template appears as an option on the "New issue" page.
179+
180+
::::::::::::::::::::::
181+
154182
::::::::::::::::::::::::::::::::::::::::::::::::::
155183

156184
:::::::::::::::::::::::::::::::::::::::::: callout
@@ -210,6 +238,25 @@ it:
210238

211239
Then commit the changes directly to your main branch.
212240

241+
:::::::::::::::::::::: solution
242+
243+
Create `.github/ISSUE_TEMPLATE/config.yml` with the two options filled in (your URL will
244+
differ):
245+
246+
```yaml
247+
blank_issues_enabled: true
248+
contact_links:
249+
- name: StarSort Community Q&A
250+
url: https://github.com/YOUR-USERNAME/YOUR-REPO/discussions
251+
about: Ask usage questions here.
252+
```
253+
254+
Once committed to `main`, the "New issue" template chooser shows your existing templates plus a
255+
button for the "StarSort Community Q&A" link. (Note: `blank_issues_enabled: false` would *hide*
256+
the blank-issue option and push people toward your templates and links instead.)
257+
258+
::::::::::::::::::::::
259+
213260
::::::::::::::::::::::::::::::::::::::::::::::::::
214261

215262
Our template chooser now shows our three templates plus the external community link.

0 commit comments

Comments
 (0)