Skip to content

Commit 126cc44

Browse files
authored
add issue template (#549)
1 parent c408230 commit 126cc44

File tree

3 files changed

+89
-0
lines changed

3 files changed

+89
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report.
3+
labels: ["bug"]
4+
title: "[Bug]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for filing a bug report.
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: What happened?
14+
description: Provide a detailed description of the bug as well as the expected behavior.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: repro
19+
attributes:
20+
label: Please provide a minimal, reproducible example of the unexpected behavior.
21+
description: Follow [these guidelines](https://stackoverflow.com/help/minimal-reproducible-example) for writing your example. Please ensure that the provided example is complete & runnable, including with dummy data if necessary.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: traceback
26+
attributes:
27+
label: Please paste any relevant traceback/logs produced by the example provided.
28+
description: This will be automatically formatted into code, so no need for backticks.
29+
render: shell
30+
- type: input
31+
id: bofire-version
32+
attributes:
33+
label: BoFire Version
34+
description: What version of BoFire are you using?
35+
validations:
36+
required: true
37+
- type: input
38+
id: python-version
39+
attributes:
40+
label: Python Version
41+
description: What version of Python are you using?
42+
validations:
43+
required: false
44+
- type: input
45+
id: os
46+
attributes:
47+
label: Operating System
48+
description: What operating system are you using?
49+
validations:
50+
required: false

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 🚀 Feature Request
2+
description: Request a feature or improvement to BoFire.
3+
labels: ["enhancement"]
4+
title: "[FEATURE REQUEST]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to request a new feature for BoFire!
10+
- type: textarea
11+
id: motivation
12+
attributes:
13+
label: Motivation
14+
description: Provide a detailed description of the problem you would like to solve via this new feature or improvement.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: pitch
19+
attributes:
20+
label: Describe the solution you'd like to see implemented in BoFire.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Describe any alternatives you've considered to the above solution.
27+
- type: textarea
28+
id: related
29+
attributes:
30+
label: Is this related to an existing issue in BoFire or another repository? If so please include links to those issues here.
31+
- type: dropdown
32+
id: pull-request
33+
attributes:
34+
label: Pull Request
35+
description: Are you willing to open a pull request implementing this feature? (See [Contributing to BoFire](https://github.com/experimental-design/bofire/blob/main/CONTRIBUTING.md))
36+
options:
37+
- "Yes"
38+
- "No"

0 commit comments

Comments
 (0)