Skip to content

Commit d0a3ecf

Browse files
committed
Use markdown headers instead of bold text for PR template
The usage of markdown headers will provide a more eye-friendly formatting without having a need to add additional newlines to the PR. This is reasoned by the GitHub markdown parser which adds additional space before and after the header. Signed-off-by: Sascha Grunert <[email protected]>
1 parent c1f36fa commit d0a3ecf

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ If the matter is security related, please disclose it privately via https://kube
1111
-->
1212

1313

14-
**What happened**:
14+
#### What happened:
1515

16-
**What you expected to happen**:
16+
#### What you expected to happen:
1717

18-
**How to reproduce it (as minimally and precisely as possible)**:
18+
#### How to reproduce it (as minimally and precisely as possible):
1919

20-
**Anything else we need to know?**:
20+
#### Anything else we need to know?:
2121

22-
**Environment**:
22+
#### Environment:
2323
- Kubernetes version (use `kubectl version`):
2424
- Cloud provider or hardware configuration:
2525
- OS (e.g: `cat /etc/os-release`):

.github/ISSUE_TEMPLATE/enhancement.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ labels: kind/feature
66
---
77
<!-- Please only use this template for submitting enhancement requests -->
88

9-
**What would you like to be added**:
9+
#### What would you like to be added:
1010

11-
**Why is this needed**:
11+
#### Why is this needed:

.github/ISSUE_TEMPLATE/failing-test.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ labels: kind/failing-test
77

88
<!-- Please only use this template for submitting reports about continuously failing tests or jobs in Kubernetes CI -->
99

10-
**Which jobs are failing**:
10+
#### Which jobs are failing:
1111

12-
**Which test(s) are failing**:
12+
#### Which test(s) are failing:
1313

14-
**Since when has it been failing**:
14+
#### Since when has it been failing:
1515

16-
**Testgrid link**:
16+
#### Testgrid link:
1717

18-
**Reason for failure**:
18+
#### Reason for failure:
1919

20-
**Anything else we need to know**:
20+
#### Anything else we need to know:

.github/ISSUE_TEMPLATE/flaking-test.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ labels: kind/flake
77

88
<!-- Please only use this template for submitting reports about flaky tests or jobs (pass or fail with no underlying change in code) in Kubernetes CI -->
99

10-
**Which jobs are flaking**:
10+
#### Which jobs are flaking:
1111

12-
**Which test(s) are flaking**:
12+
#### Which test(s) are flaking:
1313

14-
**Testgrid link**:
14+
#### Testgrid link:
1515

16-
**Reason for failure**:
16+
#### Reason for failure:
1717

18-
**Anything else we need to know**:
18+
#### Anything else we need to know:
1919
- links to go.k8s.io/triage appreciated
2020
- links to specific failures in spyglass appreciated
2121

22-
<!-- Please see the deflaking doc (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/flaky-tests.md) for more guidance! -->
22+
<!-- Please see the deflaking doc (https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/flaky-tests.md) for more guidance! -->

.github/PULL_REQUEST_TEMPLATE.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ https://git.k8s.io/community/contributors/devel/sig-release/release.md#issuepr-k
88
5. If the PR is unfinished, see how to mark it: https://git.k8s.io/community/contributors/guide/pull-requests.md#marking-unfinished-pull-requests
99
-->
1010

11-
**What type of PR is this?**
11+
#### What type of PR is this?
1212

1313
<!--
1414
Add one of the following kinds:
@@ -26,19 +26,19 @@ Optionally add one or more of the following kinds if applicable:
2626
/kind regression
2727
-->
2828

29-
**What this PR does / why we need it**:
29+
#### What this PR does / why we need it:
3030

31-
**Which issue(s) this PR fixes**:
31+
#### Which issue(s) this PR fixes:
3232
<!--
3333
*Automatically closes linked issue when PR is merged.
3434
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
3535
_If PR is about `failing-tests or flakes`, please post the related issues/tests in a comment and do not use `Fixes`_*
3636
-->
3737
Fixes #
3838

39-
**Special notes for your reviewer**:
39+
#### Special notes for your reviewer:
4040

41-
**Does this PR introduce a user-facing change?**:
41+
#### Does this PR introduce a user-facing change?
4242
<!--
4343
If no, just write "NONE" in the release-note block below.
4444
If yes, a release note is required:
@@ -50,7 +50,7 @@ For more information on release notes see: https://git.k8s.io/community/contribu
5050
5151
```
5252

53-
**Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.**:
53+
#### Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:
5454

5555
<!--
5656
This section can be blank if this pull request does not require a release note.

0 commit comments

Comments
 (0)