Skip to content

Commit ee483ca

Browse files
committed
Added bug report and discussion templates
1 parent d5ddd12 commit ee483ca

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels:
4+
- needs triage
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Please report security vulnerabilities using GitHub's [report vulnerability form](https://github.com/duckdb/duckdb/security/advisories/new).
10+
11+
- type: textarea
12+
attributes:
13+
label: What happens?
14+
description: A short, clear and concise description of what the bug is.
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
attributes:
20+
label: To Reproduce
21+
description: |
22+
Please provide steps to reproduce the behavior, preferably a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example). Please adhere the following guidelines:
23+
24+
* Format the code and the output as [code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) using triple backticks:
25+
26+
````
27+
```
28+
CODE HERE
29+
```
30+
````
31+
* Add all required imports for scripts, e.g., `import duckdb`, `import pandas as pd`.
32+
* Remove all prompts from the scripts. This include DuckDB's 'D' prompt and Python's `>>>` prompt. Removing these prompts makes reproduction attempts quicker.
33+
* Make sure that the script and its outputs are provided in separate code blocks.
34+
* If applicable, please check whether the issue is reproducible via running plain SQL queries from the DuckDB CLI client.
35+
validations:
36+
required: true
37+
38+
- type: markdown
39+
attributes:
40+
value: "# Environment (please complete the following information):"
41+
- type: input
42+
attributes:
43+
label: "OS:"
44+
placeholder: e.g., OSX
45+
description: Please include operating system version and architecture (e.g., aarch64, x86_64, etc.).
46+
validations:
47+
required: true
48+
- type: input
49+
attributes:
50+
label: "DuckDB Package Version:"
51+
placeholder: e.g., 1.3.2
52+
validations:
53+
required: true
54+
- type: input
55+
attributes:
56+
label: "Python Version:"
57+
placeholder: e.g., 3.12
58+
validations:
59+
required: true
60+
- type: markdown
61+
attributes:
62+
value: "# Identity Disclosure:"
63+
- type: input
64+
attributes:
65+
label: "Full Name:"
66+
placeholder: e.g., John Doe
67+
validations:
68+
required: true
69+
- type: input
70+
attributes:
71+
label: "Affiliation:"
72+
placeholder: e.g., Acme Corporation
73+
validations:
74+
required: true
75+
76+
- type: markdown
77+
attributes:
78+
value: |
79+
If the above is not given and is not obvious from your GitHub profile page, we might close your issue without further review. Please refer to the [reasoning behind this rule](https://berthub.eu/articles/posts/anonymous-help/) if you have questions.
80+
81+
# Before Submitting:
82+
83+
- type: dropdown
84+
attributes:
85+
label: What is the latest build you tested with? If possible, we recommend testing with the latest nightly build.
86+
description: |
87+
Visit the [installation page](https://duckdb.org/docs/installation/) for instructions.
88+
options:
89+
- I have not tested with any build
90+
- I have tested with a stable release
91+
- I have tested with a nightly build
92+
- I have tested with a source build
93+
validations:
94+
required: true
95+
96+
- type: dropdown
97+
attributes:
98+
label: Did you include all relevant data sets for reproducing the issue?
99+
options:
100+
- "No - Other reason (please specify in the issue body)"
101+
- "No - I cannot share the data sets because they are confidential"
102+
- "No - I cannot easily share my data sets due to their large size"
103+
- "Not applicable - the reproduction does not require a data set"
104+
- "Yes"
105+
default: 0
106+
validations:
107+
required: true
108+
109+
- type: checkboxes
110+
attributes:
111+
label: Did you include all code required to reproduce the issue?
112+
options:
113+
- label: Yes, I have
114+
115+
- type: checkboxes
116+
attributes:
117+
label: Did you include all relevant configuration to reproduce the issue?
118+
options:
119+
- label: Yes, I have

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature Request
4+
url: https://github.com/duckdb/duckdb-python/discussions/new?category=ideas&title=Feature%20Request:%20...&labels=feature&body=Why%20do%20you%20want%20this%20feature%3F
5+
about: Submit feature requests here
6+
- name: Discussions
7+
url: https://github.com/duckdb/duckdb-python/discussions
8+
about: Please ask and answer general questions here.

0 commit comments

Comments
 (0)