Skip to content

Commit

Permalink
[docs] New ISSUE_TEMPLATE (#12148)
Browse files Browse the repository at this point in the history
* [docs] New ISSUE_TEMPLATE

* Separate bug reports and feature requests
  • Loading branch information
oliviertassinari authored and mbrookes committed Jul 14, 2018
1 parent a009003 commit c0c4949
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 8 deletions.
20 changes: 12 additions & 8 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/1.bug.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
name: Bug report
about: Create a bug report for Material-UI
---

<!--- Provide a general summary of the issue in the Title above -->

<!--
Expand All @@ -6,22 +11,20 @@
-->

<!-- Checked checkbox should look like this: [x] -->
- [ ] This is a v1.x issue (v0.x is no longer maintained).
- [ ] This is a v1.x issue. <!-- (v0.x is no longer maintained) -->
- [ ] I have searched the [issues](https://github.com/mui-org/material-ui/issues) of this repository and believe that this is not a duplicate.

## Expected Behavior
<!---
If you're describing a bug, tell us what should happen.
If you're suggesting a change/improvement, tell us how it should work.
Describe what should happen.
-->

## Current Behavior
<!---
If describing a bug, tell us what happens instead of the expected behavior.
If suggesting a change/improvement, explain the difference from current behavior.
Describe what happens instead of the expected behavior.
-->

## Steps to Reproduce (for bugs)
## Steps to Reproduce
<!---
Provide a link to a live example (you can use codesandbox.io) and an unambiguous set of steps to reproduce this bug.
Include code to reproduce, if relevant (which it most likely is).
Expand All @@ -33,6 +36,7 @@
If YOU DO NOT take time to provide a codesandbox.io reproduction, should the COMMUNITY take time to help you?
-->
Link:

1.
2.
Expand All @@ -41,7 +45,7 @@

## Context
<!---
How has this issue affected you? What are you trying to accomplish?
What are you trying to accomplish? How has this issue affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->

Expand All @@ -53,4 +57,4 @@
| Material-UI | v1.?.? |
| React | |
| browser | |
| etc | |
| etc. | |
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Feature request
about: Create feature request for Material-UI
---

<!--- Provide a general summary of the feature in the Title above -->

<!--
Thank you very much for contributing to Material-UI by creating an issue! ❤️
To avoid duplicate issues we ask you to check off the following list.
-->

<!-- Checked checkbox should look like this: [x] -->
- [ ] This is a v1.x issue. <!-- (v0.x is no longer maintained) -->
- [ ] I have searched the [issues](https://github.com/mui-org/material-ui/issues) of this repository and believe that this is not a duplicate.

## Expected Behavior
<!---
Describe how it should work.
-->

## Current Behavior
<!---
Explain the difference from current behavior.
-->

## Examples
<!---
Provide a link to the Material design specification, other implementations,
or screenshots of the expected behavior.
-->

## Context
<!---
What are you trying to accomplish? How has the lack of this feature affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/3.support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Support
about: I need support with Material-UI
---

--------------^ Click "Preview" for a nicer view!

We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks!

---

1. Read the documentation: https://material-ui.com/.
2. Ask questions on StackOverflow using the tag material-ui: https://stackoverflow.com/questions/tagged/material-ui.
3. Chat with the community on Gitter: https://gitter.im/mui-org/material-ui.
4. Ping us on Twitter: https://twitter.com/MaterialUI.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/4.support-us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: 🤝 Support us on Material-UI
about: If you would like to support our efforts in maintaining this community-driven project 🙌!
---

--------------^ Click "Preview" for a nicer view!

> Open Collective: https://opencollective.com/material-ui
> Olivier's Patreon: https://www.patreon.com/oliviertassinari
Help support Material-UI!

Material-UI is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to the support of these awesome [backers](https://material-ui.com/discover-more/backers/).

---

As a group of volunteers you can help us in a few ways

- Giving developer time on the project. (Message us on [Twitter](https://twitter.com/MaterialUI) or [Gitter](https://gitter.im/mui-org/material-ui) for guidance).
Companies should be paying their employees to contribute back to the open source projects they use everyday.
- Giving funds by becoming one of our sponsors/donators!

If you'd like to sustain the future of the project as a whole, we have an [Open Collective](https://opencollective.com/material-ui) that you can donate to.
This is a way for funds to be allocated to the core team.

You can also support [Olivier](https://github.com/oliviertassinari) a this [Patreon](https://www.patreon.com/oliviertassinari).

0 comments on commit c0c4949

Please sign in to comment.