Add issue_templates
This commit is contained in:
49
.github/ISSUE_TEMPLATE/bug.yaml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/bug.yaml
vendored
Normal file
@ -0,0 +1,49 @@
|
||||
name: Bug Report
|
||||
description: Report a bug/problem with the library
|
||||
title: "[BUG] "
|
||||
labels: ["bug"]
|
||||
|
||||
body:
|
||||
- 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: current-behavior
|
||||
attributes:
|
||||
label: Current Behaviour
|
||||
description: >
|
||||
Please provide a description of the current behaviour. If this is a bug which produces no errors in Python, but causes unexpected output within the webview, please provide a screenshot of the web console using `Chart(debug=True)`.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: example
|
||||
attributes:
|
||||
label: Reproducible Example
|
||||
description: >
|
||||
Please provide a minimal reproducible example, using generic (`ohlcv.csv`) data where applicable which demonstrates the current behaviour. The code should be complete and not require any further adjustments.
|
||||
placeholder: >
|
||||
from lightweight_charts import Chart...
|
||||
render: python
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
examples:
|
||||
- **OS**: macOS 13.2
|
||||
- **Library**: 1.0.16.2
|
||||
value: |
|
||||
- OS:
|
||||
- Library:
|
||||
render: markdown
|
||||
validations:
|
||||
required: true
|
||||
36
.github/ISSUE_TEMPLATE/enhancement.yaml
vendored
Normal file
36
.github/ISSUE_TEMPLATE/enhancement.yaml
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
name: New Feature
|
||||
description: Request a new feature for the library
|
||||
labels: ["enhancement"]
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
id: feature-description
|
||||
attributes:
|
||||
label: Description
|
||||
description: >
|
||||
Please provide a detailed description of the requested feature. What would it do? What problem would it solve?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: code-behaviour
|
||||
attributes:
|
||||
label: Code example
|
||||
description: >
|
||||
Please provide a code example of how the new feature should behave (where applicable).
|
||||
placeholder: >
|
||||
chart.rotate(degrees=180) # flip the chart upside down
|
||||
render: python
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: method-of-implementation
|
||||
attributes:
|
||||
label: Method of implementation
|
||||
description: >
|
||||
Please provide a description of the logic of this feature/how this feature could be implemented. python/psudocode is welcome!.
|
||||
placeholder: >
|
||||
Use the `transform` CSS style to the chart, given the number of degrees provided to `rotate`.
|
||||
validations:
|
||||
required: false
|
||||
25
.github/ISSUE_TEMPLATE/question.yaml
vendored
Normal file
25
.github/ISSUE_TEMPLATE/question.yaml
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
name: General Question
|
||||
description: Ask a question/get help with the library
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: >
|
||||
Please check previous issues before submitting. Please use screenshots if they help!
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: code-behaviour
|
||||
attributes:
|
||||
label: Code example
|
||||
description: >
|
||||
Please provide any code relevant to your question.
|
||||
placeholder: >
|
||||
from lightweight_charts import Chart...
|
||||
render: python
|
||||
validations:
|
||||
required: false
|
||||
|
||||
Reference in New Issue
Block a user