Skip to content

chore: update github issue templates; add docs/troubleshooting #16077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
---
name: Bug
about: Report a bug found in Angular Material, CDK or our docs

name: Bug Report
about: Report a bug found in Angular Material or the CDK
---

#### What is the expected behavior?
#### Reproduction

Use StackBlitz to reproduce your issue: https://stackblitz.com/fork/components-issue

Steps to reproduce:
1.
2.


#### Expected Behavior

#### What is the current behavior?
What behavior were you expecting to see?


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

What behavior did you actually see?

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

#### Environment

#### Is there anything else we should know?
- Angular:
- CDK/Material:
- Browser(s):
- Operating System (e.g. Windows, macOS, Ubuntu):
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Documentation
about: Suggest an improvement to our documentation at material.angular.io
labels: docs
---

#### Documentation Feedback

Provide a brief summary of what you would like to see changed in our
documentation at material.angular.io.

Feel free to provide any suggestions of content or examples you’d like us to include.

**Affected documentation page:** Insert a link to the affected page on material.angular.io
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
name: Feature
about: Propose a new feature for Angular Material or CDK

about: Propose a new feature for Angular Material or the CDK
labels: feature
---

#### Feature Description

#### Please describe the feature you would like to request.


#### What is the use-case or motivation for this proposal?
Provide a brief summary of the feature you would like to see.

#### Use Case

#### Is there anything else we should know?
Describe the use case(s) that the proposed feature would enable.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Troubleshooting
about: Request for help on an issue you are facing with Angular Material or the CDK
labels: troubleshooting
---

<!--------

The Angular team can't provide general troubleshooting help. However, the extended community of
users can provide more help:

StackOverflow: https://stackoverflow.com/questions/tagged/angular-material2
Gitter: https://gitter.im/angular/material2
Google Groups: https://groups.google.com/forum/#!forum/angular-material2

Issues should capture only bug reports and feature requests. However, we understand that
it is not always clear whether an issue is caused by a bug or incorrect usage of a feature/component.

Most support requests will be automatically closed. If the answer is quickly obvious, though, we
might be able to provide a brief answer.

-------->


#### What are you trying to do?

What are you trying to do?

#### What troubleshooting steps have you tried?

What are you seeing that does not match your expectations?

#### Reproduction

We can only help if we can reproduce the problem ourselves.

Use StackBlitz to demonstrate what you are trying to do: https://stackblitz.com/fork/components-issue

Steps to reproduce:
1.
2.

#### Environment

- Angular:
- CDK/Material:
- Browser(s):
- Operating System (e.g. Windows, macOS, Ubuntu):