Skip to content

Commit a1cec41

Browse files
authored
Update issues template and code owners (#4556)
* Update issue template * Update accessibility.yml * Create feature_request_telemetry.yml * Update bug_report.yml * Update feature_request.yml * Update feature_request.yml * Update CODEOWNERS * Update accessibility.yml * Update accessibility.yml * Update accessibility.yml
1 parent 8ba9924 commit a1cec41

File tree

5 files changed

+295
-29
lines changed

5 files changed

+295
-29
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# https://blog.github.com/2017-07-06-introducing-code-owners/
22

3-
* @a-b-r-o-w-n @compulim @cwhitten @srinaath @tdurnford @tonyanziano @beyackle @sumeetkumar2010
3+
* @a-b-r-o-w-n @compulim @cwhitten @srinaath @tdurnford @beyackle2 @sumeetkumar2010
Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
name: Accessibility issue
2+
description: Create a report to help us improve the accessibility experience.
3+
labels:
4+
- area-accessibility
5+
- bug
6+
- customer-reported
7+
- Bot Services
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
> Please view our [accessibility guide](https://github.com/microsoft/BotFramework-WebChat/tree/main/docs/ACCESSIBILITY.md) before filing a new issue.
13+
>
14+
> Be sure to remove or obscure personally identifiable information from your code and screenshots.
15+
- type: dropdown
16+
attributes:
17+
label: Is it an issue related to Adaptive Cards?
18+
description: If yes, please verify if this issue repro on [Adaptive Cards Designer](https://adaptivecards.io/designer/). If it repro on their designer, please [file an issue to their repository](https://github.com/microsoft/AdaptiveCards/issues/new/choose).
19+
options:
20+
- ""
21+
- Yes, this is related to Adaptive Card. However, it does not repro on Adaptive Cards Designer.
22+
- "No."
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: impact
27+
attributes:
28+
label: What is the PWD impact?
29+
description: Please describe how it impact people with disabilities.
30+
- type: dropdown
31+
id: test-environment
32+
attributes:
33+
label: What browsers and screen readers do this issue affect?
34+
description: Please make sure the issue continued to repro on latest version of the browser and screen reader. If you choose "Others", please provide us information in the additional context section.
35+
multiple: true
36+
options:
37+
- "Windows: Edge with Windows Narrator"
38+
- "Windows: Chrome with NVDA"
39+
- "Windows: Chrome/Firefox with JAWS"
40+
- "macOS: Safari with VoiceOver"
41+
- "iOS/iPadOS: Safari with VoiceOver"
42+
- "Android: Chrome with TalkBack"
43+
- "Others"
44+
- type: dropdown
45+
attributes:
46+
label: Are there any code-based customization done to Web Chat?
47+
description: |
48+
If customization is done solely using `styleOptions`, please answer "No".
49+
50+
Code-based customization might affect how Web Chat works with screen readers. Please verify if this issue continue to repro without any code-based customization.
51+
options:
52+
- No, I am using Web Chat without any customizations except "styleOptions".
53+
- Yes, however, this also repro when customizations are not in use.
54+
validations:
55+
required: true
56+
- type: dropdown
57+
id: version
58+
attributes:
59+
label: What version of Web Chat are you using?
60+
description: |
61+
To determine what version of Web Chat you are running, open your browser's development tools, and paste the following line of code into the console.
62+
63+
`[].map.call(document.head.querySelectorAll('meta[name^="botframework-"]'), function (meta) { return meta.outerHTML; }).join('\n')`
64+
65+
The latest version number of Web Chat can be found in the [Releases section](https://github.com/microsoft/BotFramework-WebChat/releases/latest).
66+
67+
If you are not using latest version of Web Chat, please upgrade to the latest version as the issue may had resolved.
68+
options:
69+
- Latest production
70+
- Development build
71+
- I am not using latest
72+
- Unrelated
73+
validations:
74+
required: true
75+
- type: dropdown
76+
id: area
77+
attributes:
78+
label: Which area does this issue affect?
79+
multiple: true
80+
options:
81+
- ARIA roles
82+
- Contrast ratio
83+
- Focus management
84+
- Forced colors (high contrast mode)
85+
- Keyboard focus indicator
86+
- Keyboard navigation
87+
- Live region
88+
- Send box
89+
- Suggested action
90+
- Transcript navigation
91+
- Others or unrelated
92+
validations:
93+
required: true
94+
- type: input
95+
id: url
96+
attributes:
97+
label: What is the public URL for the website?
98+
description: If the bot is not intended for public use, please leave this blank. It will be helpful if we can test the bot to understand the issue.
99+
placeholder: "https://"
100+
- type: textarea
101+
id: repro-steps
102+
attributes:
103+
label: How to reproduce the issue?
104+
value: |
105+
1. Navigate to ...
106+
2. Type "..." in the send box
107+
3. Press <kbd>TAB</kbd> to ...
108+
validations:
109+
required: true
110+
- type: textarea
111+
id: expected-result
112+
attributes:
113+
label: What do you expect?
114+
description: Give a clear and concise description of what you expect to happen.
115+
validations:
116+
required: true
117+
- type: textarea
118+
id: actual-result
119+
attributes:
120+
label: What actually happened?
121+
description: Give a clear and concise description of what actually happened.
122+
validations:
123+
required: true
124+
- type: textarea
125+
id: screenshots
126+
attributes:
127+
label: Do you have any screenshots or recordings to repro the issue?
128+
description: Be sure to remove or obscure personally identifiable information from your code and screenshots.
129+
- type: textarea
130+
id: dom-element
131+
attributes:
132+
label: Did you find any DOM elements that might have caused the issue?
133+
description: If yes, please paste a screenshot or its code below. Knowing the suspected DOM element could greatly reduce our time on investigating and resolving the issue.
134+
- type: input
135+
id: mas-reference
136+
attributes:
137+
label: MAS reference
138+
description: For internal use only. Please link to MAS documentation, if any.
139+
placeholder: https://microsoft.sharepoint.com/:w:/r/sites/accessibility/
140+
- type: input
141+
id: wcag-reference
142+
attributes:
143+
label: WCAG reference
144+
description: Please link to related criterion from the [Understanding WCAG](https://www.w3.org/WAI/WCAG21/Understanding/) article.
145+
placeholder: https://www.w3.org/WAI/WCAG21/Understanding/
146+
- type: input
147+
id: wai-aria-reference
148+
attributes:
149+
label: WAI-ARIA reference
150+
description: For roles, state, and properties issues, please link to their related section from the [Accessible Rich Internet Applications (WAI-ARIA)](https://www.w3.org/TR/wai-aria/) article.
151+
placeholder: https://www.w3.org/TR/wai-aria/
152+
- type: textarea
153+
id: adaptive-card-json
154+
attributes:
155+
label: Adaptive Card JSON
156+
description: |
157+
If this issue is related to Adaptive Cards, please paste the JSON of the card below.
158+
159+
Please verify if this issue repro on [Adaptive Cards Designer](https://adaptivecards.io/designer/). If it repro on their designer, please [file an issue to their repository](https://github.com/microsoft/AdaptiveCards/issues/new/choose).
160+
placeholder: |
161+
{
162+
"type": "AdaptiveCard",
163+
"body": []
164+
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
165+
"version": "1.5"
166+
}
167+
render: json
168+
- type: textarea
169+
id: additional-context
170+
attributes:
171+
label: Additional context
172+
description: Add any other context about the problem here. If you have any screenshots or recordings, please include it here.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 54 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: Bug Report
2-
description: Create a report to help us improve
1+
name: Bug report
2+
description: Create a report to help us improve our product.
33
labels:
44
- bug
55
- customer-reported
@@ -11,17 +11,27 @@ body:
1111
> Please view our [Technical Support Guide](https://github.com/microsoft/BotFramework-WebChat/tree/main/docs/TECHNICAL_SUPPORT_GUIDE.md) before filing a new issue.
1212
>
1313
> [GitHub issues](https://github.com/microsoft/botframework-webchat/issues) should be used for bugs and feature requests. See the [Technical Support Guide](https://github.com/microsoft/BotFramework-WebChat/tree/main/docs/TECHNICAL_SUPPORT_GUIDE.md) to get support related to Bot Framework and Web Chat.
14-
- type: checkboxes
14+
>
15+
> Be sure to remove or obscure personally identifiable information from your code and screenshots.
16+
- type: dropdown
1517
attributes:
1618
label: Is it an issue related to Adaptive Cards?
1719
description: If yes, please verify if this issue repro on [Adaptive Cards Designer](https://adaptivecards.io/designer/). If it repro on their designer, please [file an issue to their repository](https://github.com/microsoft/AdaptiveCards/issues/new/choose).
1820
options:
19-
- label: Yes, this is an Adaptive Card issue but it is specific to Web Chat.
20-
- type: textarea
21-
id: screenshots
21+
- ""
22+
- Yes, this is an Adaptive Card issue, however it only repro on Web Chat.
23+
- "No"
24+
validations:
25+
required: true
26+
- type: dropdown
2227
attributes:
23-
label: Do you have any screenshots?
24-
description: Be sure to remove or obscure personally identifiable information from your code and screenshots
28+
label: Is this an accessibility issue?
29+
description: For accessibility issue, please use [this issue template](https://github.com/microsoft/BotFramework-WebChat/issues/new?template=accessibility.yml).
30+
options:
31+
- ""
32+
- "No"
33+
validations:
34+
required: true
2535
- type: dropdown
2636
id: version
2737
attributes:
@@ -31,7 +41,9 @@ body:
3141
3242
`[].map.call(document.head.querySelectorAll('meta[name^="botframework-"]'), function (meta) { return meta.outerHTML; }).join('\n')`
3343
34-
If you are not using latest version of Web Chat, please upgrade to the latest version as the issue may have been resolved.
44+
The latest version number of Web Chat can be found in the [Releases section](https://github.com/microsoft/BotFramework-WebChat/releases/latest).
45+
46+
If you are not using latest version of Web Chat, please upgrade to the latest version as the issue may had resolved.
3547
options:
3648
- Latest production
3749
- Development build
@@ -54,7 +66,7 @@ body:
5466
id: hosting-environment
5567
attributes:
5668
label: Which hosting environment does this issue primarily affect?
57-
description: If you choose "Others", please provide us information on your hosting environment in the Additional Context section.
69+
description: If you choose "Others or unrelated", please provide us information on your hosting environment in the additional context section.
5870
options:
5971
- Web apps
6072
- Dynamics 365 Omnichannel
@@ -82,30 +94,36 @@ body:
8294
- "Platform: macOS"
8395
- "Platform: iOS/iPadOS"
8496
- "Platform: Android"
97+
- Others or unrelated
8598
- type: dropdown
8699
id: area
87100
attributes:
88101
label: Which area does this issue affect?
89102
options:
103+
- ""
90104
- "Attachment: Adaptive Card"
91105
- "Attachment: OAuth card"
92106
- "Attachment: Other rich cards"
93107
- Chat history
94108
- "Customization: Branding"
95109
- "Customization: Others"
110+
- Development experience
111+
- Hooks
96112
- Notification
97113
- Protocol or service
98114
- Send box
99115
- Speech
100116
- Suggested action
101-
- Others/unrelated
117+
- Telemetry
118+
- Others or unrelated
102119
validations:
103120
required: true
104-
- type: checkboxes
121+
- type: input
122+
id: url
105123
attributes:
106-
label: Is this an accessibility issue?
107-
options:
108-
- label: Yes, this is an accessibility issue.
124+
label: What is the public URL for the website?
125+
description: If the bot is not intended for public use, please leave this blank. It will be helpful if we can test the bot to understand the issue.
126+
placeholder: https://
109127
- type: textarea
110128
id: describe-the-bug
111129
attributes:
@@ -118,6 +136,7 @@ body:
118136
attributes:
119137
label: Do you see any errors in console log?
120138
description: If errors are logged to the console, please copy them here.
139+
render: js
121140
- type: textarea
122141
id: repro-steps
123142
attributes:
@@ -129,30 +148,40 @@ body:
129148
validations:
130149
required: true
131150
- type: textarea
132-
id: expected-and-actual
151+
id: expected-result
133152
attributes:
134-
label: What is the expected and actual behavior?
135-
description: Give a clear and concise description of what you expect to happen and what actually happened.
136-
value: |
137-
Expected:
138-
139-
Actual:
153+
label: What do you expect?
154+
description: Give a clear and concise description of what you expect to happen.
140155
validations:
141156
required: true
157+
- type: textarea
158+
id: actual-result
159+
attributes:
160+
label: What actually happened?
161+
description: Give a clear and concise description of what actually happened.
162+
validations:
163+
required: true
164+
- type: textarea
165+
id: screenshots
166+
attributes:
167+
label: Do you have any screenshots or recordings to repro the issue?
168+
description: Be sure to remove or obscure personally identifiable information from your code and screenshots.
142169
- type: textarea
143170
id: adaptive-card-json
144171
attributes:
145172
label: Adaptive Card JSON
146-
description: If this issue is related to Adaptive Cards, please paste the JSON of the card below.
173+
description: |
174+
If this issue is related to Adaptive Cards, please paste the JSON of the card below.
175+
176+
Please verify if this issue repro on [Adaptive Cards Designer](https://adaptivecards.io/designer/). If it repro on their designer, please [file an issue to their repository](https://github.com/microsoft/AdaptiveCards/issues/new/choose).
147177
placeholder: |
148-
```json
149178
{
150179
"type": "AdaptiveCard",
151180
"body": []
152181
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
153182
"version": "1.5"
154183
}
155-
```
184+
render: json
156185
- type: textarea
157186
id: additional-context
158187
attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Feature request
2-
description: Suggest an idea for this project
2+
description: Suggest an idea for this project.
33
labels:
44
- feature-request
55
- customer-reported
@@ -10,12 +10,12 @@ body:
1010
value: |
1111
> Please view our [Technical Support Guide](https://github.com/microsoft/BotFramework-WebChat/tree/main/docs/TECHNICAL_SUPPORT_GUIDE.md) before filing a new issue.
1212
13-
Use the ['feature-request' query](https://github.com/microsoft/BotFramework-WebChat/labels/feature-request) to search for existing feature requests.
13+
Use the ["feature-request" query](https://github.com/microsoft/BotFramework-WebChat/labels/feature-request) to search for existing feature requests.
1414
1515
The [Samples tag](https://github.com/microsoft/botframework-Webchat/issues?q=is%3Aissue+is%3Aopen+label%3ASample) also lists examples and implementations that have already been requested.
1616
- type: textarea
1717
attributes:
18-
label: Is your feature request related to a problem? Please describe.
18+
label: Is your feature request related to a problem?
1919
description: A clear and concise description of what the problem is.
2020
placeholder: I'm always frustrated when [...]
2121
validations:

0 commit comments

Comments
 (0)