Skip to content

Commit ce0b456

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 ce0b456

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

keps/NNNN-kep-template/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
<!--
22
**Note:** When your KEP is complete, all of these comment blocks should be removed.
3+
Follow the guidelines of the [documentation
4+
style guide]. In particular, wrap lines to a reasonable length, to make it
5+
easier for reviewers to cite specific portions, and to minimize diff churn on
6+
updates.
7+
8+
[documentation style guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md
39
410
To get started with this template:
511
@@ -164,13 +170,6 @@ should help to ensure that the tone and content of the `Summary` section is
164170
useful for a wide audience.
165171
166172
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
174173
-->
175174

176175
## Motivation

0 commit comments

Comments
 (0)