Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit d249859

Browse files
docs(github): Update issue template (#75)
Update ISSUE_TEMPLATE.md to align with the style agreed upon across all Material Components teams.
1 parent 91e531e commit d249859

File tree

1 file changed

+34
-9
lines changed

1 file changed

+34
-9
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,56 @@
11
** PLEASE READ THIS BEFORE FILING AN ISSUE **
22

3-
## Feature Requests / Breaking Changes
3+
## Feature Requests
4+
5+
> If you're interested in requesting a new component or proposing UX changes to an existing
6+
> component, please read our Component Request Policy (_Coming Soon_) before opening an issue.
7+
8+
If you have an idea for a new feature, we'd love to hear about it! Please provide enough
9+
information regarding the feature such that we'll be able to evaluate the appropriateness and
10+
feasibility of your request. Try to be as specific as possible regarding your motivation, use-case,
11+
and potential API or affects on other APIs (where applicable). The more detailed your proposal is,
12+
the easier it will be for us to understand and evaluate it. [This Meta.SE answer](http://meta.stackexchange.com/a/259196) also contains great general guidelines for writing
13+
feature requests.
414

515
While we are in the early stages of development of MDC-Web, you can see our current progress on [master](https://github.com/material-components/material-components-web/tree/master) as well as an overview of the direction we're headed in our [developer guide](https://github.com/material-components/material-components-web/blob/master/docs/DEVELOPER.md).
616

717
If you're interested in information for a specific component, check out our [component issues](https://github.com/material-components/material-components-web/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Av2-component) to see which milestone it's associated with and subscribe to updates to it. If an issue has the `in-tracker` label, you can also take a look at our [public Pivotal Tracker](https://www.pivotaltracker.com/n/projects/1664011) for a rough estimate of when we'll get to it.
818

919
## Bugs
1020

11-
Please include the following information with your bug report:
21+
Follow the template below to ensure the quickest and most accurate response to your issue.
1222

13-
> What MDC-Web Version are you using? (please be specific, e.g. _major.minor.patch_)
23+
### What MDC-Web Version are you using?
1424

25+
> Please be specific, e.g. _major.minor.patch_
1526
16-
> What browser(s) is this bug affecting (including version)?
27+
### What browser(s) is this bug affecting?
1728

29+
> Please include the browser version. A user-agent string is also quite helpful.
1830
19-
> What OS (and version) are you using?
31+
### What OS are you using?
2032

33+
> Please include the OS version.
2134
22-
> What are the steps to reproduce the bug? Can you create a plunker/codepen/jsfiddle which reproduces it?
35+
### What are the steps to reproduce the bug?
2336

37+
> Please write the steps which need to be taken in order to reproduce the bug. These steps should be
38+
> as detailed as possible, e.g.
39+
>
40+
> 1. run the demo server
41+
> 2. go to localhost:8080/textfield.html
42+
> 3. Tab-focus on the first text field
43+
> 4. Observe the component's behavior
44+
>
45+
> If you can create a plunker/codepen/jsfiddle which reproduces it, that's even better!
2446
25-
> What is the expected behavior?
47+
### What is the expected behavior?
2648

49+
> Please describe what the component/code should be doing that it's not.
2750
28-
> What is the actual behavior?
51+
### What is the actual behavior?
2952

53+
> Please describe what the component/code is actually doing that's different from what it should be
54+
doing.
3055

31-
> Any other information you believe would be useful?
56+
### Any other information you believe would be useful?

0 commit comments

Comments
 (0)