Skip to content

Commit 1465519

Browse files
committed
Add issue template outlining feature request / bug reporting guidelines
This commit adds an [Issue Template](https://github.com/blog/2111-issue-and-pull-request-templates) to this repo alerting users to the status of features / breaking 1.x changes by the core team, as well as bug reporting guidelines. This will hopefully help stabilize the work being done for #4462
1 parent 7c7ba5c commit 1465519

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
** PLEASE READ THIS BEFORE FILING AN ISSUE **
2+
3+
## Feature Requests / Breaking Changes in mdl-1.x
4+
5+
The MDL core team has actively begun work on the next major version of MDL, dubbed **MDL v2**. Because we are a small team that's hyper-focused on delivering the best Material Design Library possible for the web, _it is highly unlikely that we will be actively working on new features or making backwards-incompatible changes for MDL as it currently exists._
6+
7+
If there is a non-breaking feature you would like to see implemented in `mdl-1.x` and are willing to contribute, we'd be happy to offer assistance with you doing so. But we will not personally be actively working on said features.
8+
9+
While we are just getting started with our next version of MDL, you can see our current progress on [master](https://github.com/google/material-design-lite/tree/master) as well as an overview of the direction we're headed in our [(WIP) developer guide](https://github.com/google/material-design-lite/blob/master/docs/DEVELOPER.md) as well as our [initial POC branch](https://github.com/google/material-design-lite/tree/experimental/v2-architecture-poc) for our new architecture.
10+
11+
If you're interested in information for a specific MDL v2 component, check out our [v2-component issues](https://github.com/google/material-design-lite/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Av2-component) to see which v2 milestone it's associated with and feel free to subscribe to that issue for updates.
12+
13+
## Bugs
14+
15+
Please include the following information with your bug report:
16+
17+
> What MDL Version are you using? (please be specific, e.g. _major.minor.patch_)
18+
19+
20+
> What browser(s) is this bug affecting (including version)?
21+
22+
23+
> What OS (and version) are you using?
24+
25+
26+
> What are the steps to reproduce the bug? Can you create a plunker/codepen/jsfiddle which reproduces it?
27+
28+
29+
> What is the expected behavior?
30+
31+
32+
> What is the actual behavior?
33+
34+
35+
> Any other information you believe would be useful?

0 commit comments

Comments
 (0)