Skip to content

Commit

Permalink
add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
lit26 committed Mar 29, 2022
1 parent 43660f3 commit 97f8697
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug Report
description: Report incorrect behavior in the finvizfinance library
title: "BUG: "
labels: [Bug, Needs Triage]

body:
- type: checkboxes
id: checks
attributes:
label: finvizfinance version checks
options:
- label: >
I have checked that this issue has not already been reported.
required: true
- label: >
I have confirmed this bug exists on the master branch of finvizfinance.
- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pastable example.
render: python
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue shown in the reproducible example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: textarea
id: version
attributes:
label: Installed Versions
description: >
Please paste the output of finvizfinance.__version__
value: >
<details>
Replace this line with the output of finvizfinance.__version__
</details>
validations:
required: true
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---

name: Feature Request
about: Suggest an idea for finvizfinance
title: "ENH:"
labels: "Enhancement, Needs Triage"

---

#### Is your feature request related to a problem?

[this should provide a description of what the problem is, e.g. "I wish I could use finvizfinance to do [...]"]

#### Describe the solution you'd like

[this should provide a description of the feature request, try to write a docstring for the desired feature]

#### API breaking implications

[this should provide a description of how this feature will affect the API]

#### Describe alternatives you've considered

[this should provide a description of any alternative solutions or features you've considered]

#### Additional context

[add any other context, code examples, or references to existing implementations about the feature request here]

```python
# Your code here, if applicable

```
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/submit_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Submit Question
description: Ask a general question about finvizfinance
title: "QST: "
labels: [Usage Question, Needs Triage]

body:
- type: markdown
attributes:
value: ---
- type: textarea
id: question
attributes:
label: Question about finvizfinance
description: >
**Note**: If you'd still like to submit a question, please read [this guide](
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
how to provide the necessary information for us to reproduce your question.
placeholder: |
```python
# Your code here, if applicable
```

0 comments on commit 97f8697

Please sign in to comment.