Skip to content

Commit bb3a3b6

Browse files
committed
KEP template: move guidance for line breaks
The last three new KEPs that I started to review all didn't use line-wrapping, including one from an experienced Kubernetes contributor. Apparently we have to put the existing guidance on line breaks into a more prominent spot.
1 parent f431a1a commit bb3a3b6

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

keps/NNNN-kep-template/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
<!--
22
**Note:** When your KEP is complete, all of these comment blocks should be removed.
33
4+
Follow the guidelines of the [documentation style guide].
5+
In particular, wrap lines to a reasonable length, to make it
6+
easier for reviewers to cite specific portions, and to minimize diff churn on
7+
updates.
8+
9+
[documentation style guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md
10+
411
To get started with this template:
512
613
- [ ] **Pick a hosting SIG.**
@@ -164,13 +171,6 @@ should help to ensure that the tone and content of the `Summary` section is
164171
useful for a wide audience.
165172
166173
A good summary is probably at least a paragraph in length.
167-
168-
Both in this section and below, follow the guidelines of the [documentation
169-
style guide]. In particular, wrap lines to a reasonable length, to make it
170-
easier for reviewers to cite specific portions, and to minimize diff churn on
171-
updates.
172-
173-
[documentation style guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md
174174
-->
175175

176176
## Motivation

0 commit comments

Comments
 (0)