Skip to content

Commit cd22af4

Browse files
authored
Changes to the issue templates (#3991)
* new changes to the issue templates * you ARE * adding type removing title * final fix
1 parent 2af9113 commit cd22af4

File tree

5 files changed

+68
-46
lines changed

5 files changed

+68
-46
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml renamed to .github/ISSUE_TEMPLATE/1-bug-report.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Bug Report
33
description: File a bug report
4-
title: '[BUG]: '
5-
labels: [bug]
4+
labels: [backend]
5+
type: Bug
66
body:
77
- type: markdown
88
attributes:
@@ -13,17 +13,15 @@ body:
1313
attributes:
1414
label: Contact Details [Optional]
1515
description: How can we get in touch with you if we need more info?
16-
placeholder: your@awesome.com
16+
placeholder: youre@awesome.com
1717
validations:
1818
required: false
1919
- type: textarea
2020
id: system-information
2121
attributes:
2222
label: System Information
2323
description: zenml info -a -s
24-
placeholder: Copy paste the output of the above command here. If using ZenML
25-
< 0.36.0, then remove the `-s` flag above. If using ZenML version < 0.8.0,
26-
then paste in Python version, OS, ZenML version, and installed integrations.
24+
placeholder: Copy paste the output of the above command here.
2725
validations:
2826
required: false
2927
- type: textarea
@@ -58,7 +56,7 @@ body:
5856
id: terms
5957
attributes:
6058
label: Code of Conduct
61-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
59+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE-OF-CONDUCT.md)
6260
options:
6361
- label: I agree to follow this project's Code of Conduct
6462
required: true

.github/ISSUE_TEMPLATE/feature_report.yml renamed to .github/ISSUE_TEMPLATE/2-feature-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Feature Request
33
description: Suggest a new feature or enhancement
4-
title: '[FEATURE]: '
5-
labels: [enhancement, feature-request]
4+
type: Feature
5+
labels: [backend]
66
body:
77
- type: markdown
88
attributes:
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: General Issue
3+
description: I have a general issue I would like to write about
4+
type: Task
5+
labels: [backend]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report a general issue! This helps us improve ZenML.
11+
- type: input
12+
id: contact
13+
attributes:
14+
label: Contact Details [Optional]
15+
description: How can we get in touch with you if we need more info?
16+
placeholder: [email protected]
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: system-information
21+
attributes:
22+
label: System Information
23+
description: zenml info -a -s
24+
placeholder: Copy paste the output of the above command here.
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: issue-description
29+
attributes:
30+
label: Issue Description
31+
description: What is the general issue you'd like to report?
32+
placeholder: A clear and concise description of your issue.
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: code-snippet
37+
attributes:
38+
label: Code Snippet [Optional]
39+
description: Where possible please include a self-contained code snippet that
40+
exemplifies your issue
41+
value: |
42+
```python
43+
import zenml
44+
45+
# Your code here
46+
```
47+
render: markdown
48+
validations:
49+
required: false
50+
- type: checkboxes
51+
id: terms
52+
attributes:
53+
label: Code of Conduct
54+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE-OF-CONDUCT.md)
55+
options:
56+
- label: I agree to follow this project's Code of Conduct
57+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
blank_issues_enabled: true
2+
blank_issues_enabled: false
33
contact_links:
4-
- name: Feature Request
5-
url: https://zenml.io/discussion
6-
about: Request a new feature.
7-
- name: Slack Channel
8-
url: https://zenml.io/slack/
9-
about: Chat with us directly here.
104
- name: Docs
115
url: https://docs.zenml.io/
126
about: Read the docs to answer most commonly asked questions.
7+
- name: Slack Channel
8+
url: https://zenml.io/slack/
9+
about: Chat with us directly here.

.github/issue_template.md

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

0 commit comments

Comments
 (0)