Skip to content

Commit 410a445

Browse files
authored
Add GitHub issue and PR templates (#5)
* Add GitHub issue and PR templates Signed-off-by: Eoin Fennessy <[email protected]> * Link to Kubeflow Training WG meeting Signed-off-by: Eoin Fennessy <[email protected]> * Get Kubeflow Trainer version in bug report Signed-off-by: Eoin Fennessy <[email protected]> * Link to Kubeflow Trainer slack channel Signed-off-by: Eoin Fennessy <[email protected]> --------- Signed-off-by: Eoin Fennessy <[email protected]>
1 parent 2efd57e commit 410a445

File tree

4 files changed

+106
-0
lines changed

4 files changed

+106
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug Report
2+
description: Tell us about a problem you are experiencing with Kubeflow SDK
3+
labels: ["kind/bug", "lifecycle/needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this Kubeflow SDK bug report!
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: What happened?
13+
description: |
14+
Please provide as much info as possible. Not doing so may result in your bug not being
15+
addressed in a timely manner.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected
20+
attributes:
21+
label: What did you expect to happen?
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: environment
26+
attributes:
27+
label: Environment
28+
value: |
29+
Kubernetes version:
30+
```bash
31+
$ kubectl version
32+
33+
```
34+
Kubeflow Trainer version:
35+
```bash
36+
$ kubectl get pods -n kubeflow -l app.kubernetes.io/name=trainer -o jsonpath="{.items[*].spec.containers[*].image}"
37+
38+
```
39+
Kubeflow Python SDK version:
40+
```bash
41+
$ pip show kubeflow
42+
43+
```
44+
validations:
45+
required: true
46+
- type: input
47+
id: votes
48+
attributes:
49+
label: Impacted by this bug?
50+
value: Give it a 👍 We prioritize the issues with most 👍

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: Kubeflow Documentation
5+
url: https://www.kubeflow.org/docs/
6+
about: Much help can be found in the docs
7+
- name: Kubeflow Trainer Slack Channel
8+
url: https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels
9+
about: Ask the Kubeflow Trainer community on CNCF Slack
10+
- name: Kubeflow Training and AutoML WG Community Meeting
11+
url: https://bit.ly/2PWVCkV
12+
about: Join the Kubeflow Training working group meeting
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature Request
2+
description: Suggest an idea for Kubeflow SDK
3+
labels: ["kind/feature", "lifecycle/needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this Kubeflow SDK feature request!
9+
- type: textarea
10+
id: feature
11+
attributes:
12+
label: What you would like to be added?
13+
description: |
14+
A clear and concise description of what you want to add to Kubeflow SDK.
15+
Please consider to write Kubeflow Enhancement Proposal (KEP) if it is a large feature request.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: rationale
20+
attributes:
21+
label: Why is this needed?
22+
validations:
23+
required: true
24+
- type: input
25+
id: votes
26+
attributes:
27+
label: Love this feature?
28+
value: Give it a 👍 We prioritize the features with most 👍

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Thanks for sending a pull request! Here are some tips for you:
2+
1. If this is your first time, check our contributor guidelines: https://www.kubeflow.org/docs/about/contributing
3+
2. To know more about Kubeflow SDK, check the developer guide:
4+
https://github.com/kubeflow/sdk/blob/main/CONTRIBUTING.md
5+
3. If you want *faster* PR reviews, check how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
6+
-->
7+
8+
**What this PR does / why we need it**:
9+
10+
**Which issue(s) this PR fixes** _(optional, in `Fixes #<issue number>, #<issue number>, ...` format, will close the issue(s) when PR gets merged)_:
11+
12+
Fixes #
13+
14+
**Checklist:**
15+
16+
- [ ] [Docs](https://www.kubeflow.org/docs/) included if any changes are user facing

0 commit comments

Comments
 (0)