Skip to content

Commit 52ee607

Browse files
authored
Introduces a new set of issue/discussion templates (#5456)
Based on the community model of ghostty-org/ghostty#3558 --------- Signed-off-by: Nicholas Gates <[email protected]>
1 parent d2e6eb2 commit 52ee607

File tree

4 files changed

+79
-27
lines changed

4 files changed

+79
-27
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
labels: ["needs-confirmation"]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
> [!IMPORTANT]
7+
> Please check for both existing [Discussions](https://github.com/vortex-data/vortex/discussions) and [Issues](https://github.com/vortex-data/vortex/issues) prior to opening a new Discussion.
8+
- type: markdown
9+
attributes:
10+
value: "# Issue Details"
11+
- type: textarea
12+
attributes:
13+
label: Issue Description
14+
description: |
15+
Provide a detailed description of the issue. Include relevant information, such as:
16+
- Which integration you are using if any, e.g. DataFusion, DuckDB, Polars, etc.
17+
- Which language you are using, e.g. Python, Rust, Java, etc.
18+
- The Vortex package version you are using.
19+
- If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR, commit) in your description.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Expected Behavior
25+
description: |
26+
Describe how you expect Vortex to behave in this situation. Include any relevant documentation links.
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Actual Behavior
32+
description: |
33+
Describe how Vortex actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please be sure to mention the deviation specifically.
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Reproduction Steps
39+
description: |
40+
Provide a detailed set of step-by-step instructions for reproducing this issue.
41+
validations:
42+
required: true
43+
- type: input
44+
attributes:
45+
label: OS Version Information
46+
description: |
47+
Please tell us what operating system (name and version) you are using.
48+
placeholder: Ubuntu 24.04.1 (Noble Numbat)
49+
validations:
50+
required: true
51+
52+
- type: markdown
53+
attributes:
54+
value: |
55+
# User Acknowledgements
56+
> [!TIP]
57+
> Use these links to review the existing Vortex [Discussions](https://github.com/vortex-data/vortex/discussions) and [Issues](https://github.com/vortex-data/vortex/issues).
58+
- type: checkboxes
59+
attributes:
60+
label: "I acknowledge that:"
61+
options:
62+
- label: I have searched the Vortex repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an existing issue or discussion.
63+
required: true
64+
- label: I have checked the "Preview" tab on all text fields to ensure that everything looks right, and have wrapped all configuration and code in code blocks with a group of three backticks (` ``` `) on separate lines.
65+
required: true

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Features, Bug Reports, Questions
4+
url: https://github.com/vortex-data/vortex/discussions/new/choose
5+
about: Our preferred starting point if you have any questions or suggestions about configuration, features or behavior.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Pre-Discussed and Approved Topics
3+
about: |-
4+
Only for topics already discussed and approved in the GitHub Discussions section.
5+
---
6+
7+
**DO NOT OPEN A NEW ISSUE. PLEASE USE THE DISCUSSIONS SECTION.**
8+
9+
**I DIDN'T READ THE ABOVE LINE. PLEASE CLOSE THIS ISSUE.**

0 commit comments

Comments
 (0)