Skip to content

Commit

Permalink
chore: Upgrade GH issue templates to GH forms (#4449)
Browse files Browse the repository at this point in the history
  • Loading branch information
zundertj committed Aug 17, 2022
1 parent 32e33fe commit 82178cb
Show file tree
Hide file tree
Showing 8 changed files with 253 additions and 136 deletions.
95 changes: 0 additions & 95 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_nodejs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Bug Report - NodeJS
description: An issue with NodeJS polars
labels: [bug, nodejs]

body:
- type: checkboxes
id: checks
attributes:
label: Polars 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
[latest version](https://www.npmjs.com/package/nodejs-polars) of polars.
required: true

- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a high-level description of the issue
validations:
required: true

- 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. Include the (wrong) output if applicable.
render: javascript
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
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_python.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Bug Report - Python
description: An issue with python polars
labels: [bug, python]

body:
- type: checkboxes
id: checks
attributes:
label: Polars 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
[latest version](https://pypi.org/project/polars/) of polars.
required: true

- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a high-level description of the issue
validations:
required: true

- 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. Include the (wrong) output if applicable.
placeholder: >
import polars as pl

import numpy as np

# Create a simple dataset on which we can reproduce the bug.

pl.DataFrame({
"foo": [None, 1, 2],
"bar": np.arange(3)
})

...
render: python
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 ``pl.show_versions()``
value: >
<details>

Replace this line with the output of pl.show_versions()

</details>
validations:
required: true
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_rust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report - Rust
description: An issue with Rust polars
labels: [bug, rust]

body:
- type: checkboxes
id: checks
attributes:
label: Polars 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
[latest version](https://crates.io/crates/polars) of polars.
required: true

- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a high-level description of the issue
validations:
required: true

- 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. Include the (wrong) output if applicable.
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 tell us which feature gates you used
value: >
<details>

Replace this line with a list of feature gates

</details>
validations:
required: true
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: Suggest a new feature for polars
labels: [feature]


body:
- type: textarea
id: description
attributes:
label: Problem Description
description: >
Please describe the behavior you want and the motivation. Please also provide
examples of how polars would be used if your feature request were added.

If you're not sure what to write here, then try imagining what the ideal
documentation of your new feature would look like. Then try to write it.
placeholder: >
I wish I could use polars to ...
validations:
required: true
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

0 comments on commit 82178cb

Please sign in to comment.