Skip to content

Commit

Permalink
Adds templates
Browse files Browse the repository at this point in the history
  • Loading branch information
repraze committed Jun 29, 2019
1 parent 7b6d470 commit ec12f70
Show file tree
Hide file tree
Showing 5 changed files with 346 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

:thumbsup: Thank you for taking the time to contribute to this project!

## How to contribute

### :star: Feature request

- Create a new **issue** from the `Feature request` template
- Fill all the sections of the template

### :bug: Reporting a bug

- Create a new **issue** from the `Bug report` template
- Fill all the sections of the template

### :pencil: Making changes

- **Fork** the repository
- Make your changes on a **new topic branch**
- Make commits of logical units with **sensible messages**
- Submit a **pull request** to the repository
- Fill all the sections of the template
- Reviewers will look at and you will get feedback
- The pull request may be closed if no activity is seen for a few weeks

It may take a while for developers to review a pull request. Feel free to contact them.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug
---

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

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

### Screenshots

If applicable, add screenshots to help explain your problem.
ScreenToGif is also good.

### Desktop

- OS: [e.g. Windows 10]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Additional context

Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
labels: enhancement
---

### Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like

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

### Additional context

Add any other context or screenshots about the feature request here.
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Purpose

Describe the problem or feature in addition to a link to the issues using the `Fixes #(number)`. This will automatically close the issues when the PR is merged.

### Approach

How does this change address the problem?

### Test

How has this change been tested?

### Checklist

- [ ] Completed code
- [ ] Updated tests
- [ ] Achieved full coverage
- [ ] Updated documentation

### Open Questions and Pre-Merge TODOs

- [ ] Use github checklists. When solved, check the box and explain the answer.
243 changes: 243 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ec12f70

Please sign in to comment.