From db6d109a9471e5d044cc7af64c9231c34146f169 Mon Sep 17 00:00:00 2001 From: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com> Date: Sun, 31 Dec 2023 10:04:58 -0300 Subject: [PATCH] CONTRIBUTING: emphasize right use of placeholders (#11946) Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d05eb509..705c62a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,6 +85,14 @@ Other examples but not limited to of our placeholder syntax are: - `{{path/to/directory}}` - `{{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, refer to the [style guide](contributing-guides/style-guide.md).