-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] setup GitHub issue template for feddbacks about docs
- Loading branch information
1 parent
79e7ce2
commit 9641c51
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Docs feedback | ||
description: Improve documentation about MUI Core. | ||
labels: ['status: needs triage', 'support: docs-feedback'] | ||
title: '[docs] ' | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please provide a searchable summary of the issue in the title above ⬆️. | ||
Thanks for contributing by creating an issue! ❤️ | ||
- type: checkboxes | ||
attributes: | ||
label: Duplicates | ||
description: Please [search the history](https://github.com/mui/material-ui/issues) to see if an issue already exists for the same problem. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
|
||
- type: input | ||
id: page-url | ||
attributes: | ||
label: Related page | ||
description: Which page of the documentation is this about? | ||
placeholder: https://mui.com/material-ui/react-badge/ | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
attributes: | ||
label: Kind of issue | ||
description: What kind of problem are you facing? | ||
options: | ||
- Unclear explanations | ||
- Missing information | ||
- Broken demonstration | ||
- Other | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Issue description | ||
description: | | ||
Let us know what went wrong when you were using this documentation and what we could do to improve it. | ||
value: | | ||
I was looking for ... and it appears that ... | ||
- type: textarea | ||
attributes: | ||
label: Context 🔦 | ||
description: What are you trying to accomplish? What brought you to this page? Your context can help us to come up with solutions that benefit the community as a whole. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters