-
Notifications
You must be signed in to change notification settings - Fork 6.8k
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
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a097bbf
chore: update github issue templates; add docs/troubleshooting
andrewseguin d4bce3b
Operation -> Operating
andrewseguin a380bd7
add labels automatically
andrewseguin e88bca4
OSX -> macOS
andrewseguin 699950b
troubleshooting template re-write by Jeremy
andrewseguin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, OSX, Ubuntu): | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
andrewseguin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
name: Troubleshooting | ||
about: Request for help on an issue you are facing with Angular Material or the CDK | ||
labels: troubleshooting | ||
--- | ||
|
||
<!-------- | ||
|
||
We have an amazing community of users that would love to help you troubleshoot issues. | ||
|
||
You can reach out to them here: | ||
StackOverflow: https://stackoverflow.com/questions/tagged/angular-material2 | ||
Gitter: https://gitter.im/angular/material2 | ||
Google Groups: https://groups.google.com/forum/#!forum/angular-material2 | ||
|
||
We want to keep issues open only for 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. | ||
|
||
You are welcome to ask for our help, but please be aware that we have very limited bandwidth. | ||
|
||
We can only assist if we can understand the problem and quickly reproduce the issue. Otherwise, we | ||
may close the issue and request that you ask for help from the community instead. | ||
|
||
--------> | ||
|
||
|
||
#### Expected Outcome | ||
|
||
What are you trying to do? | ||
|
||
#### Actual Outcome | ||
|
||
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, OSX, Ubuntu): |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.