Adding the CLI Style Guide #530
Conversation
|
|
CLI-STYLE-GUIDE.md
Outdated
| @@ -0,0 +1,246 @@ | |||
| # Pantheon CLI Style Guide | |||
There was a problem hiding this comment.
CLI -> Command Line? Personal preference but would command line be better than CLI in the titles.
There was a problem hiding this comment.
I've gone back and forth on this as well. I've updated the title to "Command Line Interface (CLI)". I do think it's more clear after doing some research. In addition to that, it made me realize we were being inconsistent with using a hyphen or not (command-line vs. command line). I've matched what existed in the documentation already and changed them all to "command line" (no hyphen).
CLI-STYLE-GUIDE.md
Outdated
|
|
||
| ## General Guidelines | ||
|
|
||
| There are four guiding principles for the Pantheon CLI to help us create a good developer experience for both new and expert users: **_(1) be consistent, (2) keep it simple, (3) be proactive and (4) be informative (to people and machines)._** |
There was a problem hiding this comment.
Would it be clearer to have each numbered point on a separate line?
There was a problem hiding this comment.
I'm hesitant to do this since they're broken out after this section.
…nd changed command-line to commane line (no hypen to be consistent)
PR description
Added in the CLI Style Guide (top level), new "images" folder and image files in /docs, updated README to link to the CLI Style Guide
Fixed Issue(s)