Skip to content

Commit d00bd06

Browse files
committed
KEP template: add 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 need better guidance.
1 parent f431a1a commit d00bd06

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

keps/NNNN-kep-template/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ When editing KEPS, aim for tightly-scoped, single-topic PRs to keep discussions
4444
focused. If you disagree with what is already in a document, open a new PR
4545
with suggested changes.
4646
47+
Wrap long lines instead of using one line per paragraph. When updating, change
48+
as few lines as possible. This helps with anchoring review comments. Semantic
49+
line breaks (https://sembr.org/) are useful.
50+
4751
One KEP corresponds to one "feature" or "enhancement" for its whole lifecycle.
4852
You do not need a new KEP to move from beta to GA, for example. If
4953
new details emerge that belong in the KEP, edit the KEP. Once a feature has become

0 commit comments

Comments
 (0)