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

Commit

Permalink
docs: add github issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
gregberge committed Jan 4, 2019
1 parent 4982672 commit 1a19f7c
Show file tree
Hide file tree
Showing 7 changed files with 113 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,3 @@
## 👉 [Please follow one of these issue templates](https://github.com/smooth-code/smooth-ui/issues/new/choose) 👈

Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,31 @@
---

name: 🐛 Bug report
about: Create a report to help us improve
--->

## 🐛 Bug Report

A clear and concise description of what the bug is.

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

Please provide a minimal repository on GitHub.

Issues without a reproduction link are likely to stall.

## Run `npx envinfo --system --binaries --npmPackages @smooth-ui/core-sc,@smooth-ui/core-em,styled-components,emotion,react-emotion --markdown --clipboard`

Paste the results here:

```bash
```
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,20 @@
---
name: 🚀 Feature Proposal
about: Submit a proposal for a new feature
---

## 🚀 Feature Proposal

A clear and concise description of what the feature is.

## Motivation

Please outline the motivation for the proposal.

## Example

Please provide an example for how this feature would be used.

## Pitch

Why does this feature belong in the Jest Puppeteer ecosystem?
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,13 @@
---
name: 💬 Questions / Help
about: If you have questions, please read full readme first
---

## 💬 Questions and Help

Smooth UI project is young, but please before asking your question:

- Read carefully the README of the project
- Search if your answer has already been answered in old issues

After you can submit your question and we will be happy to help you!
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/regression.md
@@ -0,0 +1,36 @@
---
name: 💥 Regression Report
about: Report unexpected behavior that worked in previous versions
---

## 💥 Regression Report

A clear and concise description of what the regression is.

## Last working version

Worked up to version:

Stopped working in version:

## To Reproduce

Steps to reproduce the behavior:

## Expected behavior

A clear and concise description of what you expected to happen.

## Link to repl or repo (highly encouraged)

Please provide a minimal repository on GitHub.

Issues without a reproduction link are likely to stall.

## Run `npx envinfo --system --binaries --npmPackages @smooth-ui/core-sc,@smooth-ui/core-em,styled-components,emotion,react-emotion --markdown --clipboard`

Paste the results here:

```bash

```
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory. -->

## Summary

<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->

## Test plan

<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->
1 change: 1 addition & 0 deletions .github/SUPPORT.md
@@ -0,0 +1 @@
Please read carefully [the documentation](https://smooth-ui.smooth-code.com) before asking questions.

0 comments on commit 1a19f7c

Please sign in to comment.