ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: emphasize right use of placeholders (#11946) 

Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
pull/23/head
Vitor Henrique 2023-12-31 10:04:58 -03:00 committed by GitHub
parent d5c93c019d
commit db6d109a94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -85,6 +85,14 @@ Other examples but not limited to of our placeholder syntax are:
- `{{path/to/directory}}` - `{{path/to/directory}}`
- `{{path/to/directory1 path/to/directory2 ...}}` - `{{path/to/directory1 path/to/directory2 ...}}`
However, if the description suggests a specific value, leave it as part of the command, and **not** as a placeholder, for example:
```md
- Display records more recent than 3 days:
`lastlog --time 3`
```
For more detailed formatting guidelines, For more detailed formatting guidelines,
refer to the [style guide](contributing-guides/style-guide.md). refer to the [style guide](contributing-guides/style-guide.md).