|
1 | 1 | ** PLEASE READ THIS BEFORE FILING AN ISSUE ** |
2 | 2 |
|
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. |
4 | 14 |
|
5 | 15 | 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). |
6 | 16 |
|
7 | 17 | 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. |
8 | 18 |
|
9 | 19 | ## Bugs |
10 | 20 |
|
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. |
12 | 22 |
|
13 | | -> What MDC-Web Version are you using? (please be specific, e.g. _major.minor.patch_) |
| 23 | +### What MDC-Web Version are you using? |
14 | 24 |
|
| 25 | +> Please be specific, e.g. _major.minor.patch_ |
15 | 26 |
|
16 | | -> What browser(s) is this bug affecting (including version)? |
| 27 | +### What browser(s) is this bug affecting? |
17 | 28 |
|
| 29 | +> Please include the browser version. A user-agent string is also quite helpful. |
18 | 30 |
|
19 | | -> What OS (and version) are you using? |
| 31 | +### What OS are you using? |
20 | 32 |
|
| 33 | +> Please include the OS version. |
21 | 34 |
|
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? |
23 | 36 |
|
| 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! |
24 | 46 |
|
25 | | -> What is the expected behavior? |
| 47 | +### What is the expected behavior? |
26 | 48 |
|
| 49 | +> Please describe what the component/code should be doing that it's not. |
27 | 50 |
|
28 | | -> What is the actual behavior? |
| 51 | +### What is the actual behavior? |
29 | 52 |
|
| 53 | +> Please describe what the component/code is actually doing that's different from what it should be |
| 54 | +doing. |
30 | 55 |
|
31 | | -> Any other information you believe would be useful? |
| 56 | +### Any other information you believe would be useful? |
0 commit comments