Merge pull request #1040 from embark-framework/feat/issue-templates

chore: introduce issue and pull request templates
This commit is contained in:
Iuri Matias 2018-11-08 16:26:24 -05:00 committed by GitHub
commit 60a75d8b7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 106 additions and 35 deletions

View File

@ -1,24 +0,0 @@
## Overview
**TL;DR**
<One to two sentence description of the issue you are encountering.>
### Extra Detail
#### Steps to reproduce
1.
2.
3.
#### Screenshots
<please upload images of the error to better showcase the problem.>
#### Logs
<please upload logs of the error to better showcase the problem. You can use the following options: --nodashboard --logfile log.txt --loglevel trace>
#### Context (Environment)
* OS:
* Embark Version:
* Node Version:
* NPM Version:
### Questions?
- Leave a comment on this issue! Make sure to use @ mentions if you want a specific person's attention!

44
.github/ISSUE_TEMPLATE/Bug.md vendored Normal file
View File

@ -0,0 +1,44 @@
---
name: 🐞 Bug Report
about: Something is broken? 🔨
---
### Bug Report
#### Summary
<!-- Provide a summary describing the problem you are experiencing. -->
#### Current behavior
<!--
What is the current (buggy) behavior? Feel free to add as much information as possible.
Also, a screenshot often says more than a thousand words. :)
-->
#### How to reproduce
<!--
Provide steps to reproduce the bug.
Adding a failing Unit or Functional Test would help us a lot - you can submit one in a Pull Request separately, referencing this bug report.
-->
#### Expected behavior
<!-- What was the expected (correct) behavior? -->
#### If you encounter an error, please create a logfile using the following command and post the output here
```
$ embark run --nodashboard --logfile log.txt --loglevel trace
```
#### Please provide additional information about your system
**OS**:
**Embark Version**:
**Node Version**:
**NPM Version**:
#### Sometimes issues are related to Embark's installation. Can you provide information on how Embark was installed?

View File

@ -0,0 +1,13 @@
---
name: 🎉 Feature Request
about: You have a neat idea that should be implemented? 🎩
---
### Feature Request
<!-- Fill in the relevant information below to help triage your issue. -->
#### Summary
<!-- Provide a summary of the feature you would like to see implemented. -->

9
.github/ISSUE_TEMPLATE/Proposal.md vendored Normal file
View File

@ -0,0 +1,9 @@
---
name: 🤔 Proposal
about: Have a nice proposal?
---
### Proposal description
<!-- Describe the proposal you want here. -->

View File

@ -1,11 +0,0 @@
## Overview
**TL;DR**
<One to two sentence description of the issue you are encountering or trying to solve.>
### Questions
<If relevant, write a list of questions that you would like to discuss related to the changes that you have made.>
### Review
<use @mentions for quick questions, specific feedback, and progress updates.>
### Cool Spaceship Picture

20
.github/PULL_REQUEST_TEMPLATE/Bugfix.md vendored Normal file
View File

@ -0,0 +1,20 @@
---
name: ⚙ Bugfix
about: Fixed a bug? 🐞
---
### What bug have you fixed?
<!-- Fill in the relevant information below to help triage your issue. -->
#### How did you fix it (give a brief summary)?
<!-- Provide a summary of the improvement you are submitting. -->
### Questions
<If relevant, write a list of questions that you would like to discuss related to the changes that you have made.>
### Review
<use @mentions for quick questions, specific feedback, and progress updates.>
### Cool Spaceship Picture

View File

@ -0,0 +1,20 @@
---
name: ⚙ Feature
about: Implemented a new feature? 🎁
---
### What feature did you implement?
<!-- Fill in the relevant information below to help triage your issue. -->
#### Anything that needs special attention (breaking changes etc)?
<!-- Provide a summary of the improvement you are submitting. -->
### Questions
<If relevant, write a list of questions that you would like to discuss related to the changes that you have made.>
### Review
<use @mentions for quick questions, specific feedback, and progress updates.>
### Cool Spaceship Picture