diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index 38fad8f48d..25d5259693 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -104,6 +104,11 @@ Example: ``` - Pre-translated alias page templates can be found [here](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md). +## Option syntax + +- Use GNU-style **long options** (like `--help` rather than `-h`) when they are cross-platform compatible (available on multiple platforms where a command is intended to work among `android`, `linux`, `osx`, `sunos`, `windows`). +- In other cases use short options (like `-h`). + ## Token syntax User-provided values should use the `{{token}}` syntax