Update readme with contributing guide and create github templates (#110)

This commit is contained in:
alex bezek 2020-10-22 12:31:44 -04:00 committed by GitHub
parent c85bcf8488
commit 5bc4c2a406
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 117 additions and 4 deletions

37
.github/ISSUE_TEMPLATE/bug.md vendored Normal file
View file

@ -0,0 +1,37 @@
---
name: Bug
about: File a bug report.
title: 'bug'
---
## Expected Behavior
<!--- Tell us what should happen -->
## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.
### Screenshots
<!--- Provide any screenshots or links to deployments -->
### Browsers Affected
<!-- Check all that apply -->
- [ ] Chrome
- [ ] Firefox
- [ ] Edge
- [ ] Safari 11
- [ ] Safari 10
- [ ] IE 11
## Detailed Description
<!--- Provide a detailed description of the change or addition you are proposing -->

View file

@ -0,0 +1,30 @@
---
name: Feature Request
about: File a Feature Request.
title: 'Feature Request'
---
<!---
Before filing an issue, please review the following:
Existing Features: https://github.com/hossainemruz/toha#features
Project Roadmap: https://github.com/hossainemruz/toha#project-roadmap
-->
### Describe the solution you'd like
<!--
Provide a clear and concise description of what you want to happen.
-->
### Describe alternatives you've considered
<!--
Let us know about other solutions you've tried or researched.
-->
### Additional context
<!--
Is there anything else you can add about the proposal?
You might want to link to related issues here, if you haven't already.
-->

9
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View file

@ -0,0 +1,9 @@
---
name: Question
about: Ask a general question.
---
<!--- Use this template for general questions. For bug reports or feature requests, please use those templates -->
### Question
<!--- Insert your question here. Please provide as much detail as possible. -->