Update readme with contributing guide and create github templates (#110)
This commit is contained in:
parent
c85bcf8488
commit
5bc4c2a406
5 changed files with 117 additions and 4 deletions
37
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
37
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal 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 -->
|
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal 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
9
.github/ISSUE_TEMPLATE/question.md
vendored
Normal 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. -->
|
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,10 @@
|
|||
### Issue
|
||||
<!--- Insert a link to the associated github issue here. -->
|
||||
|
||||
### Description
|
||||
|
||||
<!-- Insert details about what the changes being proposed are. -->
|
||||
|
||||
### Test Evidence
|
||||
|
||||
<!-- Provide screenshot evidence and/or testing steps to validate the proposed changes. -->
|
Loading…
Add table
Add a link
Reference in a new issue