diff options
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index ad2cbee974b..a43952eaad6 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -1303,6 +1303,14 @@ For example, you might write something like: Use lowercase for **push rules**. +## `README` file + +Use backticks and lowercase for **the `README` file**, or **the `README.md` file**. + +When possible, use the full phrase: **the `README` file** + +For plural, use **`README` files**. + ## recommend, we recommend Instead of **we recommend**, use **you should**. We want to talk to the user the way |