add github actions, fix readme for pypi

This commit is contained in:
Your Name
2022-03-17 17:03:40 +01:00
parent b0c4f56d95
commit 93d8e09808
9 changed files with 189 additions and 3 deletions

23
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
The piece of code that reproduce the bug.
**Expected behavior**
A clear and concise description of what you expected to happen.
**Output**
The obtained output. Please include the entire error trace.
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**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.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

14
.github/ISSUE_TEMPLATE/help-wanted.md vendored Normal file
View File

@@ -0,0 +1,14 @@
---
name: Help wanted
about: Ask help for using the package
title: ''
labels: help wanted
assignees: ''
---
**The objective**
A clear description of the purpose of your application.
**Already tried tests**
The snippet of code you have already tried in order to obtain the wanted outcome.