Skip to content
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

[core] Improve the feedback loop from developers #2468

Merged
merged 3 commits into from
Aug 29, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 0 additions & 74 deletions .github/ISSUE_TEMPLATE/1.bug.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/1.bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug report 🐛
description: Create a bug report for MUI X.
labels: ['status: needs triage']
body:
- type: markdown
attributes:
value: |
Pease provide a summary of the issue developers can search in the title above ⬆️.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

Thank you very much for contributing by creating an issue! ❤️
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](/~https://github.com/mui-org/material-ui-x/issues) to see if an issue already exists on the same problem.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Latest version
description: We roll bug fixes, performance enhancements, and other improvements into new releases.
options:
- label: I have tested the latest version
required: true
- type: textarea
attributes:
label: Current Behavior 😯
description: Describe what happens instead of the expected behavior.
- type: textarea
attributes:
label: Expected Behavior 🤔
description: Describe what should happen.
- type: textarea
attributes:
label: Steps to Reproduce 🕹
description: |
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).

You can use the official codesandbox template as a starting point: https://material-ui.com/r/issue-template-latest.

If you have an issue concerning TypeScript please start from this TypeScript playground: https://material-ui.com/r/ts-issue-template.

Issues that we can't reproduced are closed.
value: |
Steps:

1.
2.
3.
4.
- type: textarea
attributes:
label: Context 🔦
description: 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.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
- type: input
id: contact
attributes:
label: Order id 💳
description: The [Pro plan](https://mui.com/pricing) comes with priority over the Community plan. Providing your order id might give your problem more attention.
placeholder: 'ex. #11111'
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/2.feature.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request 💄
description: Suggest a new idea for MUI X.
labels: ['status: needs triage']
body:
- type: markdown
attributes:
value: |
Pease provide a summary of the issue developers can search in the title above ⬆️.

Thank you very much for contributing by creating an issue! ❤️
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](/~https://github.com/mui-org/material-ui-x/issues) to see if an issue already exists on the same problem.
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Latest version
description: We roll bug fixes, performance enhancements, and other improvements into new releases.
options:
- label: I have tested the latest version
required: true
- type: textarea
attributes:
label: Summary 💡
description: Describe how it should work.
- type: textarea
attributes:
label: Examples 🌈
description: Provide a link to the Material Design specification, other implementations, or screenshots of the expected behavior.
- type: textarea
attributes:
label: Motivation 🔦
description: 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.
- type: input
id: contact
attributes:
label: Order id 💳
description: The [Pro plan](https://mui.com/pricing) comes with priority over the Community plan. Providing your order id might give your problem more attention.
placeholder: 'ex. #11111'
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/3.pro-support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 'Pro plan: support ❔'
description: As a Pro plan user, I need support with MUI X.
title: "[question] "
labels: ['status: needs triage', 'pro plan', 'question']
body:
- type: markdown
attributes:
value: |
Pease provide a summary of the issue developers can search in the title above ⬆️.

⚠️ **Don't use this form if the problem is a bug or a feature request, use the dedicated form instead.**

Thank you very much for contributing by creating an issue! ❤️
- type: input
id: contact
attributes:
label: Order id 💳
description: The order id used for the purchase of the Pro plan. Community users can [learn more about support](https://material-ui.com/getting-started/support/) in the documentation.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
placeholder: 'ex. #11111'
validations:
required: true
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](/~https://github.com/mui-org/material-ui-x/issues) to see if an issue already exists on the same problem.
options:
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Latest version
description: We roll bug fixes, performance enhancements, and other improvements into new releases.
options:
- label: I have tested the latest version
required: true
- type: textarea
attributes:
label: Summary 💡
- type: textarea
attributes:
label: The problem in depth 🔍
- type: textarea
attributes:
label: Context 🔦
description: 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.
- type: textarea
attributes:
label: Your Environment 🌎
description: Run `npx @material-ui/envinfo` and post the results. If you encounter issues with TypeScript please include the used tsconfig.
value: |
<details>
<summary>`npx @material-ui/envinfo`</summary>

```
Don't forget to mention which browser you used.
Output from `npx @material-ui/envinfo` goes here.
```
</details>
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
blank_issues_enabled: false # force the usage of a template
contact_links:
- name: Support ❔
url: https://material-ui.com/getting-started/support/
about: I need support with Material-UI.
about: I need support with MUI X.