Skip to content

Commit bff2684

Browse files
liudmylaruliudmylaru
committed
ODSC-43553. Add templated to repository
- added bug_report.yml - added config.yml with link to the documentation - added feature_request.yml
1 parent f88638b commit bff2684

File tree

3 files changed

+145
-0
lines changed

3 files changed

+145
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

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

‎.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: Check the docs
4+
url: https://oci-mlflow.readthedocs.io
5+
about: If you need help with your first steps with oci-mlflow please check the docs.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Feature Request
2+
description: Feature and enhancement proposals in oci-mlflow library
3+
title: "[FR]: "
4+
labels: [Task, Backlog]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Before proceeding, please review the [Contributing to this repository](https://github.com/oracle/oci-mlflow/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
11+
12+
---
13+
14+
Thank you for submitting a feature request.
15+
- type: dropdown
16+
id: contribution
17+
attributes:
18+
label: Willingness to contribute
19+
description: Would you or another member of your organization be willing to contribute an implementation of this feature?
20+
options:
21+
- Yes. I can contribute this feature independently.
22+
- Yes. I would be willing to contribute this feature with guidance from the oci-mlflow team.
23+
- No. I cannot contribute this feature at this time.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Proposal Summary
29+
description: |
30+
In a few sentences, provide a clear, high-level description of the feature request
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Motivation
36+
description: |
37+
- What is the use case for this feature?
38+
- Why is this use case valuable to support for OCI DataScience users in general?
39+
- Why is this use case valuable to support for your project(s) or organization?
40+
- Why is it currently difficult to achieve this use case?
41+
value: |
42+
> #### What is the use case for this feature?
43+
44+
> #### Why is this use case valuable to support for OCI DataScience users in general?
45+
46+
> #### Why is this use case valuable to support for your project(s) or organization?
47+
48+
> #### Why is it currently difficult to achieve this use case?
49+
validations:
50+
required: true
51+
- type: textarea
52+
attributes:
53+
label: Details
54+
description: |
55+
Use this section to include any additional information about the feature. If you have a proposal for how to implement this feature, please include it here. For implementation guidelines, please refer to the [Contributing to this repository](https://github.com/oracle/oci-mlflow/blob/main/CONTRIBUTING.md).
56+
validations:
57+
required: false

0 commit comments

Comments
 (0)