Skip to content

Commit 4c3ed56

Browse files
authored
Merge pull request #279 from bcgov/docs
Update GitHub issue templates
2 parents 63341b6 + 7799abc commit 4c3ed56

File tree

7 files changed

+130
-74
lines changed

7 files changed

+130
-74
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug
2+
description: Report an error or unexpected behaviour in a component
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
projects: ["bcgov/121"]
6+
assignees:
7+
- mkernohanbc
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this bug report! Please provide as much information as possible, including screenshots if possible.
13+
- type: input
14+
id: component
15+
attributes:
16+
label: Component
17+
description: Which component does this bug affect?
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Description
24+
description: Describe the error or unexpected behaviour you observed, and provide screenshots if possible
25+
placeholder: Tell us what's going wrong
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: reproduction
30+
attributes:
31+
label: Steps to reproduce
32+
description: Describe the circumstances under which the bug occurs
33+
placeholder: What were you doing when the bug occurred?
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: technical
38+
attributes:
39+
label: Technical information
40+
description: What browsers or platforms does the bug affect?
41+
placeholder: Desktop or mobile? All browsers, or only one?
42+
validations:
43+
required: true

.github/ISSUE_TEMPLATE/component-bug-report.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/component.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: New component
2+
description: Propose a new component to be added to the design system
3+
title: "[Component request]: "
4+
labels: ["component"]
5+
projects: ["bcgov/121"]
6+
assignees:
7+
- mkernohanbc
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
We evaluate prospective new components based on:
13+
* Demonstrable impact in terms of functionality or usability of government digital service
14+
* Evidence that the functional need can't be met using existing components
15+
* Demand from the user community
16+
- type: input
17+
id: name
18+
attributes:
19+
label: Component name
20+
description: A short, descriptive name for this component
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description: Summary of what the component does, and its expected behaviour
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: rationale
32+
attributes:
33+
label: Rationale
34+
description: Brief explanation of why this component is required, and how it will enhance application or service functionality and usability
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: additional
39+
attributes:
40+
label: Additional information
41+
description: Links to any examples, research or code to support your proposal, if available
42+
validations:
43+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

.github/ISSUE_TEMPLATE/content-edit-request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Enhancement
2+
description: Suggest a change to how an existing component looks or behaves
3+
title: "[Enhancement]: "
4+
labels: ["enhancement"]
5+
projects: ["bcgov/121"]
6+
assignees:
7+
- mkernohanbc
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
We evaluate prospective enhancements based on:
13+
* Demonstrable impact in terms of functionality or usability of government digital service
14+
* Technical complexity and impact on existing services
15+
* Demand from the user community
16+
- type: input
17+
id: name
18+
attributes:
19+
label: Related component
20+
description: Which component does this proposed enhancement affect?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description: Describe the proposed change
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: rationale
32+
attributes:
33+
label: Rationale
34+
description: Explain why you are proposing this change, and the expected benefit to the user
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: additional
39+
attributes:
40+
label: Additional information
41+
description: Links to any examples, research or code to support your proposal, if available
42+
validations:
43+
required: true

.github/ISSUE_TEMPLATE/propose-a-new-component.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)