Skip to content

Commit f8be532

Browse files
andrewseguinmmalerba
authored andcommitted
chore: update github issue templates; add docs/troubleshooting (#16077)
* chore: update github issue templates; add docs/troubleshooting * Operation -> Operating * add labels automatically * OSX -> macOS * troubleshooting template re-write by Jeremy
1 parent b3f8480 commit f8be532

File tree

4 files changed

+88
-17
lines changed

4 files changed

+88
-17
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
11
---
2-
name: Bug
3-
about: Report a bug found in Angular Material, CDK or our docs
4-
2+
name: Bug Report
3+
about: Report a bug found in Angular Material or the CDK
54
---
65

7-
#### What is the expected behavior?
6+
#### Reproduction
7+
8+
Use StackBlitz to reproduce your issue: https://stackblitz.com/fork/components-issue
89

10+
Steps to reproduce:
11+
1.
12+
2.
13+
14+
15+
#### Expected Behavior
916

10-
#### What is the current behavior?
17+
What behavior were you expecting to see?
1118

1219

13-
#### What are the steps to reproduce?
14-
Providing a StackBlitz reproduction is the *best* way to share your issue. <br/>
15-
StackBlitz starter: https://goo.gl/wwnhMV<br/>
20+
#### Actual Behavior
1621

22+
What behavior did you actually see?
1723

18-
#### Which versions of Angular, Material, OS, TypeScript, browsers are affected?
1924

25+
#### Environment
2026

21-
#### Is there anything else we should know?
27+
- Angular:
28+
- CDK/Material:
29+
- Browser(s):
30+
- Operating System (e.g. Windows, macOS, Ubuntu):

.github/ISSUE_TEMPLATE/docs.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Documentation
3+
about: Suggest an improvement to our documentation at material.angular.io
4+
labels: docs
5+
---
6+
7+
#### Documentation Feedback
8+
9+
Provide a brief summary of what you would like to see changed in our
10+
documentation at material.angular.io.
11+
12+
Feel free to provide any suggestions of content or examples you’d like us to include.
13+
14+
**Affected documentation page:** Insert a link to the affected page on material.angular.io

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
name: Feature
3-
about: Propose a new feature for Angular Material or CDK
4-
3+
about: Propose a new feature for Angular Material or the CDK
4+
labels: feature
55
---
6+
7+
#### Feature Description
68

7-
#### Please describe the feature you would like to request.
8-
9-
10-
#### What is the use-case or motivation for this proposal?
9+
Provide a brief summary of the feature you would like to see.
1110

11+
#### Use Case
1212

13-
#### Is there anything else we should know?
13+
Describe the use case(s) that the proposed feature would enable.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Troubleshooting
3+
about: Request for help on an issue you are facing with Angular Material or the CDK
4+
labels: troubleshooting
5+
---
6+
7+
<!--------
8+
9+
The Angular team can't provide general troubleshooting help. However, the extended community of
10+
users can provide more help:
11+
12+
StackOverflow: https://stackoverflow.com/questions/tagged/angular-material2
13+
Gitter: https://gitter.im/angular/material2
14+
Google Groups: https://groups.google.com/forum/#!forum/angular-material2
15+
16+
Issues should capture only bug reports and feature requests. However, we understand that
17+
it is not always clear whether an issue is caused by a bug or incorrect usage of a feature/component.
18+
19+
Most support requests will be automatically closed. If the answer is quickly obvious, though, we
20+
might be able to provide a brief answer.
21+
22+
-------->
23+
24+
25+
#### What are you trying to do?
26+
27+
What are you trying to do?
28+
29+
#### What troubleshooting steps have you tried?
30+
31+
What are you seeing that does not match your expectations?
32+
33+
#### Reproduction
34+
35+
We can only help if we can reproduce the problem ourselves.
36+
37+
Use StackBlitz to demonstrate what you are trying to do: https://stackblitz.com/fork/components-issue
38+
39+
Steps to reproduce:
40+
1.
41+
2.
42+
43+
#### Environment
44+
45+
- Angular:
46+
- CDK/Material:
47+
- Browser(s):
48+
- Operating System (e.g. Windows, macOS, Ubuntu):

0 commit comments

Comments
 (0)