Skip to content

Commit 9bf23e5

Browse files
authored
Add Doc checklist to PR template (#1568)
1 parent 61d7008 commit 9bf23e5

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,14 @@
1-
<!-- Thanks for sending a pull request! Here are some tips for you:
2-
1. If this is your first time, read our contributor guidelines https://git.k8s.io/community/contributors/guide/pull-requests.md#the-pull-request-submit-process and developer guide https://git.k8s.io/community/contributors/devel/development.md#development-guide
3-
2. If you want *faster* PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
4-
3. Follow the instructions for writing a release note: https://git.k8s.io/community/contributors/guide/release-notes.md
5-
4. If the PR is unfinished, see how to mark it: https://git.k8s.io/community/contributors/guide/pull-requests.md#marking-unfinished-pull-requests
6-
5. If this PR changes image versions, please title this PR "Bump <image name> from x.x.x to y.y.y."
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 Katib components, check developer guide https://github.com/kubeflow/katib/blob/master/docs/developer-guide.md
4+
3. If you want *faster* PR reviews, check how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
75
-->
86

97
**What this PR does / why we need it**:
108

11-
**Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*:
9+
**Which issue(s) this PR fixes** _(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)_:
1210
Fixes #
1311

14-
**Special notes for your reviewer**:
12+
**Checklist:**
1513

16-
1. Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.
17-
18-
**Release note**:
19-
<!-- Write your release note:
20-
1. Enter your extended release note in the below block. If the PR requires additional action from users switching to the new release, include the string "action required".
21-
2. If no release note is required, just write "NONE".
22-
-->
23-
```release-note
24-
25-
```
14+
- [ ] [Docs](https://www.kubeflow.org/docs/components/katib/) included if any changes are user facing

0 commit comments

Comments
 (0)