kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make kubectl help strings consistent

This commit is contained in:
joe2far 2016-06-07 18:38:04 +01:00
parent 8e1eb3f045
commit 91f8164944
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
kubectl-conventions.md
View File

@ -125,6 +125,9 @@ flags and separate help that is tailored for the particular usage.
* Flag names and single-character aliases should have the same meaning across * Flag names and single-character aliases should have the same meaning across
all commands all commands
* Flag descriptions should start with an uppercase letter and not have a
period at the end of a sentence
* Command-line flags corresponding to API fields should accept API enums * Command-line flags corresponding to API fields should accept API enums
exactly (e.g., `--restart=Always`) exactly (e.g., `--restart=Always`)
@ -233,9 +236,16 @@ resources in other commands
an exhaustive specification an exhaustive specification
* Short should contain a one-line explanation of what the command does * Short should contain a one-line explanation of what the command does
* Short descriptions should start with an uppercase case letter and not
have a period at the end of a sentence
* Short descriptions should (if possible) start with a first person
(singular present tense) verb
* Long may contain multiple lines, including additional information about * Long may contain multiple lines, including additional information about
input, output, commonly used flags, etc. input, output, commonly used flags, etc.
* Long descriptions should use proper grammar, start with an uppercase
letter and have a period at the end of a sentence
* Example should contain examples * Example should contain examples
* Start commands with `$` * Start commands with `$`