Skip to content
This repository was archived by the owner on Jun 20, 2022. It is now read-only.

Commit 1a19f7c

Browse files
committed
docs: add github issue template
1 parent 4982672 commit 1a19f7c

File tree

7 files changed

+113
-0
lines changed

7 files changed

+113
-0
lines changed

β€Ž.github/ISSUE_TEMPLATE.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## πŸ‘‰ [Please follow one of these issue templates](https://github.com/smooth-code/smooth-ui/issues/new/choose) πŸ‘ˆ
2+
3+
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
3+
name: πŸ› Bug report
4+
about: Create a report to help us improve
5+
--->
6+
7+
## πŸ› Bug Report
8+
9+
A clear and concise description of what the bug is.
10+
11+
## To Reproduce
12+
13+
Steps to reproduce the behavior:
14+
15+
## Expected behavior
16+
17+
A clear and concise description of what you expected to happen.
18+
19+
## Link to repl or repo (highly encouraged)
20+
21+
Please provide a minimal repository on GitHub.
22+
23+
Issues without a reproduction link are likely to stall.
24+
25+
## Run `npx envinfo --system --binaries --npmPackages @smooth-ui/core-sc,@smooth-ui/core-em,styled-components,emotion,react-emotion --markdown --clipboard`
26+
27+
Paste the results here:
28+
29+
```bash
30+
31+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: πŸš€ Feature Proposal
3+
about: Submit a proposal for a new feature
4+
---
5+
6+
## πŸš€ Feature Proposal
7+
8+
A clear and concise description of what the feature is.
9+
10+
## Motivation
11+
12+
Please outline the motivation for the proposal.
13+
14+
## Example
15+
16+
Please provide an example for how this feature would be used.
17+
18+
## Pitch
19+
20+
Why does this feature belong in the Jest Puppeteer ecosystem?
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: πŸ’¬ Questions / Help
3+
about: If you have questions, please read full readme first
4+
---
5+
6+
## πŸ’¬ Questions and Help
7+
8+
Smooth UI project is young, but please before asking your question:
9+
10+
- Read carefully the README of the project
11+
- Search if your answer has already been answered in old issues
12+
13+
After you can submit your question and we will be happy to help you!
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: πŸ’₯ Regression Report
3+
about: Report unexpected behavior that worked in previous versions
4+
---
5+
6+
## πŸ’₯ Regression Report
7+
8+
A clear and concise description of what the regression is.
9+
10+
## Last working version
11+
12+
Worked up to version:
13+
14+
Stopped working in version:
15+
16+
## To Reproduce
17+
18+
Steps to reproduce the behavior:
19+
20+
## Expected behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Link to repl or repo (highly encouraged)
25+
26+
Please provide a minimal repository on GitHub.
27+
28+
Issues without a reproduction link are likely to stall.
29+
30+
## Run `npx envinfo --system --binaries --npmPackages @smooth-ui/core-sc,@smooth-ui/core-em,styled-components,emotion,react-emotion --markdown --clipboard`
31+
32+
Paste the results here:
33+
34+
```bash
35+
36+
```
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory. -->
2+
3+
## Summary
4+
5+
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
6+
7+
## Test plan
8+
9+
<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->

β€Ž.github/SUPPORT.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Please read carefully [the documentation](https://smooth-ui.smooth-code.com) before asking questions.

0 commit comments

Comments
Β (0)