Skip to content

Commit d3d45f2

Browse files
authored
ODSC-37075. Create a bug template for github issues (#51)
1 parent ff553fc commit d3d45f2

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Bug Report
2+
description: Bug observed in oracle-ads library
3+
title: "[Bug]: "
4+
labels: [Bug, Backlog]
5+
assignees:
6+
- octocat
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
If you think you've found a security vulnerability, don't raise a GitHub issue and follow the instructions
12+
in our [security policy](https://github.com/oracle/accelerated-data-science/security/policy).
13+
14+
---
15+
16+
Thank you for taking the time to file a bug report.
17+
- type: checkboxes
18+
id: checks
19+
attributes:
20+
label: Oracle-ads version used
21+
options:
22+
- label: >
23+
I have checked that this issue has not already been reported.
24+
required: true
25+
- label: >
26+
I have confirmed this bug exists on the
27+
[latest version](https://https://github.com/oracle/accelerated-data-science/releases/) of oracle-ads.
28+
- label: >
29+
I have confirmed this bug exists on the main branch of oracle-ads.
30+
- label: >
31+
I agree to follow [Code of Conduct](https://github.com/oracle/.github/blob/main/CODE_OF_CONDUCT.md).
32+
required: true
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: Description
37+
description: >
38+
Please provide a brief description of the problem, describe setup used as that may be the key to the issue.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: how-to-reproduce
43+
attributes:
44+
label: How to Reproduce
45+
description: >
46+
Please provide a copy-pastable short code example.
47+
If possible provide an ordered list of steps on how to reproduce the problem.
48+
placeholder: >
49+
import ads
50+
51+
...
52+
render: python
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: what-was-observed
57+
attributes:
58+
label: What was Observed
59+
description: >
60+
Please provide snippets of output or describe wrong behavior.
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: what-was-expected
65+
attributes:
66+
label: What was Expected
67+
description: >
68+
Please describe what should have happened and how it is different from what was observed.
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: version
73+
attributes:
74+
label: Version
75+
description: >
76+
Please paste the output of ``ads.__version__``
77+
value: >
78+
<details>
79+
80+
Paste here the output of ads.__version__
81+
82+
</details>
83+
validations:
84+
required: true

.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: Check the docs
4+
url: https://accelerated-data-science.readthedocs.io/en/latest/
5+
about: If you need help with your first steps with oracle-ads please check the docs.
6+
- name: Security vulnerabilities
7+
url: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
8+
about: How to report security vulnerabilities to Oracle.

0 commit comments

Comments
 (0)