Skip to content

Commit

Permalink
style: Update issue templates (#947)
Browse files Browse the repository at this point in the history
* Remove some title prefixes; issues receive default labels
* Switch bold text to headers for accessibility
* Minor edits and Prettier formatting
  • Loading branch information
brendangadd committed Mar 22, 2022
1 parent 79e147b commit 695af5b
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 28 deletions.
31 changes: 19 additions & 12 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: 'BUG: <app name> <description>'
title: "<app name>: <description>"
labels: kind/bug
assignees: ''

assignees: ""
---

**Describe the bug**
#### Describe the bug

A clear and concise description of what the bug is.

**Environment info**
#### Environment info

Namespace:
Notebook/server:

**To Reproduce**
Notebook/server:

#### Steps to reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
2. Click on '...'
3. Scroll down to '...'
4. See error

**Expected behaviour**
#### Expected behaviour

A clear and concise description of what you expected to happen.

**Screenshots**
#### Screenshots

If applicable, add screenshots to help explain your problem.

**Additional context**
#### Additional context

Add any other context about the problem here.
23 changes: 14 additions & 9 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT] <app name> <description>"
title: "<app name>: <description>"
labels: kind/feature
assignees: ''

assignees: ""
---

**Is your feature request related to a problem? Please link issue ticket.**
Link to existing project ticket that contains a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
#### Is your feature request related to a problem? Please link issue ticket

Link to existing project ticket that contains a clear and concise description of
what the problem is. Ex. I'm always frustrated when [...]

#### Describe the solution you'd like

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
#### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've
considered.

#### Additional context

**Additional context**
Add any other context or screenshots about the feature request here.
16 changes: 9 additions & 7 deletions .github/ISSUE_TEMPLATE/onboarding-support-help.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
name: Onboarding support/help
about: Just got your account setup and need help getting started?
title: "[HELP] <my goal>"
labels: help-wanted
assignees: ''

title: "[Help] <my goal>"
labels: triage/support
assignees: ""
---

Before submitting your ticket did you first try the following?
- [ ] have you checked our wiki? https://statcan.github.io/daaas/
- [ ] ask your questions in our Slack support channel? https://statcan-aaw.slack.com

- [ ] Checked our wiki? https://statcan.github.io/daaas/
- [ ] Asked your questions in our Slack support channel?
https://statcan-aaw.slack.com

If you did, then let us know what's up!
**Describe what you need help with**

#### Describe what you need help with

0 comments on commit 695af5b

Please sign in to comment.