mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-18 23:06:31 +00:00
Change documentation style guide to favour Oxford Comma (#1086)
This commit is contained in:
parent
93c667e1b6
commit
f635aad186
@ -6,11 +6,14 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
|
||||
|
||||
## General Documentation
|
||||
|
||||
Broadly speaking documentation should be written following Microsoft's house style, which is detailed [here](https://docs.microsoft.com/en-us/style-guide).
|
||||
|
||||
- The language of the documentation should be American-English.
|
||||
- Don't put two spaces after a period and avoid the "Oxford comma".
|
||||
- Don't put two spaces after a period.
|
||||
- Use a serial comma (also known as the Oxford comma) before the conjunction in a list of three or more items. E.g., "Through the use of additional adapters, Home Assistant allows the use of Zigbee, Z-Wave, and other protocols".
|
||||
- There is no limit for the line length. You are allowed to write in a flowing text style. This will make it easier to use the GitHub online editor in the future.
|
||||
- Be objective and not gender favoring, polarizing, race related or religion inconsiderate.
|
||||
- The case of brand names, services, protocols, integrations and platforms must match its respective counterpart. e.g., "Z-Wave" **not** "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" **not** "input select" or "Input select".
|
||||
- Be objective and not gender favoring, polarizing, race related or religion inconsiderate. Contributions which do not follow this may be in breach of our [Code of Conduct](https://github.com/home-assistant/core/blob/master/CODE_OF_CONDUCT.md).
|
||||
- The case of brand names, services, protocols, integrations and platforms must match its respective counterpart. E.g., "Z-Wave" **not** "Zwave", "Z-wave", "Z Wave" or "ZWave". Also, "Input Select" **not** "input select" or "Input select".
|
||||
- Do not use ALL CAPITALS for emphasis - use _italics_ instead.
|
||||
- All examples containing Jinja2 templates should be wrapped **outside** of the code markdown with the `{% raw %}` tag.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user