Skip to content

Commit

Permalink
add spaces after period and indentation guidelines (Kong#1767)
Browse files Browse the repository at this point in the history
* add spaces after period and indentation guidelines

* Apply suggestions from code review

Co-authored-by: Aron Eidelman <[email protected]>
  • Loading branch information
Peter Kim and Aron Eidelman authored Feb 5, 2020
1 parent 36c83e8 commit ee4b44b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,11 @@ For multiple lines of code or an example command, use a
Do not use in-line formatting for anything that should be in
[bold text](#bold-text).

### indentation
Do not add indentation unless it's functionally relevant, e.g., in YAML files, sub-bulleted lists.

Unnecessary indentation can potentially conflict with styling that CSS applies to the markdown. In general, keep the markdown free of styling as much as possible, outside of what's already documented here for things like inline code, entities, etc.

### Kong
Use proper case.

Expand Down Expand Up @@ -295,6 +300,9 @@ Joined as a noun/modifier, separated as a phrasal verb.
### Services
Use proper case.

### spaces after a period. one, not two (or three or four)
Use one space after a period, not two.

### super admin
Use lowercase, hyphen as a compound modifier. Note that an
[Admin](#admin-admin) is a Kong entity, whereas **admin** and **super admin**
Expand Down

0 comments on commit ee4b44b

Please sign in to comment.