From 7891c1bc64c7f1276552e26ff83ae26aad69a07b Mon Sep 17 00:00:00 2001 From: louisnw Date: Tue, 5 Sep 2023 12:39:15 +0100 Subject: [PATCH] Add issue_templates --- .github/ISSUE_TEMPLATE/bug.yaml | 49 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.yaml | 36 ++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yaml | 25 +++++++++++++ 3 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yaml create mode 100644 .github/ISSUE_TEMPLATE/question.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000..f8cb0dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml new file mode 100644 index 0000000..7ca328d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000..45d6ae2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -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 +