Skip to content

Commit

Permalink
chore(python,rust): Small updates to issue templates (pola-rs#9789)
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego authored Jul 9, 2023
1 parent 5ceee5b commit f8fc68c
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 96 deletions.
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/bug_report_nodejs.yml

This file was deleted.

40 changes: 15 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report_python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: checkboxes
id: checks
attributes:
label: Polars version checks
label: Checks
options:
- label: >
I have checked that this issue has not already been reported.
Expand All @@ -16,36 +16,26 @@ body:
[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.
value: |
```python
pl.DataFrame({
"foo": [None, 1, 2],
"bar": np.arange(3)
})
```
validations:
required: true

...
render: python
- type: textarea
id: problem
attributes:
label: Issue description
description: >
Provide any additional information you think might be relevant.
validations:
required: true

Expand All @@ -54,7 +44,7 @@ body:
attributes:
label: Expected behavior
description: >
Please describe or show a code example of the expected behavior.
Describe or show a code example of the expected behavior.
validations:
required: true

Expand All @@ -63,12 +53,12 @@ body:
attributes:
label: Installed versions
description: >
Please paste the output of ``pl.show_versions()``
Paste the output of ``pl.show_versions()``
value: |
<details>
```
Replace this line with the output of pl.show_versions(), leave the backticks in place
Replace this line with the output of pl.show_versions(). Leave the backticks in place.
```
</details>
Expand Down
26 changes: 15 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report_rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: checkboxes
id: checks
attributes:
label: Polars version checks
label: Checks
options:
- label: >
I have checked that this issue has not already been reported.
Expand All @@ -17,21 +17,25 @@ body:
required: true
- type: textarea
id: problem
id: example
attributes:
label: Issue description
label: Reproducible example
description: >
Please provide a high-level description of the issue.
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.
value: |
```rust
```
validations:
required: true

- type: textarea
id: example
id: problem
attributes:
label: Reproducible example
label: Issue description
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.
Provide any additional information you think might be relevant.
validations:
required: true

Expand All @@ -40,7 +44,7 @@ body:
attributes:
label: Expected behavior
description: >
Please describe or show a code example of the expected behavior.
Describe or show a code example of the expected behavior.
validations:
required: true

Expand All @@ -49,8 +53,8 @@ body:
attributes:
label: Installed versions
description: >
Please tell us which feature gates you used.
value: >
List the feature gates you used.
value: |
<details>
Replace this line with a list of feature gates
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ contact_links:
- name: '💬 Discord server'
url: https://discord.gg/4UfP5cfBE7
about: |
Chat with the community and Polars maintainers about both the usage of and development of the project.
Chat with the community and Polars maintainers about the usage and development of the project.
9 changes: 2 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ body:
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 were added.
If you're not sure what to write here, 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 ...
Please describe the feature or enhancement and explain why it should be implemented.
Include a code example if applicable.
validations:
required: true
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,40 @@ body:
- type: markdown
attributes:
value: >
Is your question related to syntax or how you could do something with the polars library?
Is your question related to syntax or how you could do something with the Polars library?
Please use [Stack Overflow](https://stackoverflow.com/) and one of the following tags:
* [python-polars](https://stackoverflow.com/questions/tagged/python-polars)
* [rust-polars](https://stackoverflow.com/questions/tagged/rust-polars)
* [nodejs-polars](https://stackoverflow.com/questions/tagged/nodejs-polars)
This allows us to create high quality answers that remain updated and will save us from
answering the same questions over and over again.
If a question is not yet on Stack Overflow, please create a new question and post the link here, so we are notified.
- type: checkboxes
attributes:
label: Research
options:
- label: >
I have searched the above polars tags on Stack Overflow for similar questions.
I have searched the above Polars tags on Stack Overflow for similar questions.
required: true
- label: >
I have asked my usage related question on [Stack Overflow](https://stackoverflow.com).
required: false
- type: input
id: question-link
attributes:
label: Link to question on Stack Overflow
validations:
required: false

- type: markdown
attributes:
value: ---

- type: textarea
id: question
attributes:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you're unclear on how to proceed after reading this guide, please contact us

We use [GitHub issues](https://github.com/pola-rs/polars/issues) to track bugs and suggested enhancements.
You can report a bug by opening a [new issue](https://github.com/pola-rs/polars/issues/new/choose).
Use the appropriate issue type for the language you are using ([Rust](https://github.com/pola-rs/polars/issues/new?labels=bug&template=bug_report_rust.yml) / [Python](https://github.com/pola-rs/polars/issues/new?labels=bug&template=bug_report_python.yml) / [Node.js](https://github.com/pola-rs/polars/issues/new?labels=bug&template=bug_report_nodejs.yml)).
Use the appropriate issue type for the language you are using ([Rust](https://github.com/pola-rs/polars/issues/new?labels=bug&template=bug_report_rust.yml) / [Python](https://github.com/pola-rs/polars/issues/new?labels=bug&template=bug_report_python.yml)).

Before creating a bug report, please check that your bug has not already been reported, and that your bug exists on the latest version of Polars.
If you find a closed issue that seems to report the same bug you're experiencing, open a new issue and include a link to the original issue in your issue description.
Expand Down

0 comments on commit f8fc68c

Please sign in to comment.