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

[docs] Add issue templates #222

Merged
merged 1 commit into from
Aug 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
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
Empty file added .github/CODEOWNERS
Empty file.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/1.bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Bug report 🐛
about: Create a bug report for Material-UI X.
labels: 'status: needs triage'
---

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

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

<!-- Checked checkbox should look like this: [x] -->

- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://github.com/mui-org/material-ui-x/issues) of this repository and believe that this is not a duplicate.

## Current Behavior 😯

<!-- Describe what happens instead of the expected behavior. -->

## Expected Behavior 🤔

<!-- Describe what should happen. -->

## 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).

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

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

Issues without some form of live example have a longer response time.
-->

Steps:

1.
2.
3.
4.

## Context 🔦

<!--
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.
-->

## Your Environment 🌎

<!--
Include as many relevant details about the environment with which you experienced the bug.
If you encounter issues with TypeScript please include version and tsconfig.
-->

| Tech | Version |
| ------------- | ------- |
| Material-UI X | v0.?.? |
| React | |
| Browser | |
| TypeScript | |
| etc. | |
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/2.feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature request 💄
about: Suggest a new idea for the project.
labels: 'status: needs triage'
---

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

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

<!-- Checked checkbox should look like this: [x] -->

- [ ] I have searched the [issues](https://github.com/mui-org/material-ui-x/issues) of this repository and believe that this is not a duplicate.

## Summary 💡

<!-- Describe how it should work. -->

## Examples 🌈

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

## Motivation 🔦

<!--
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.
-->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
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.