From 18c7d5b5c1594a5769597c57b5b2b0b805458d6c Mon Sep 17 00:00:00 2001 From: Janik von Rotz Date: Tue, 26 May 2026 10:34:20 +0200 Subject: [PATCH] feat(agents-guide): add logging guidelines for quote usage and sentence punctuation --- AGENTS.md | 9 ++++++++- AGENTS.md.template | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 9152f07..b2e3679 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -97,4 +97,11 @@ The following guideline is heavily based on the [Bash Style Guide | ysap.sh](htt - Use globbing (`*`) to iterate over files, not `ls`. - Avoid `cat` when a command can read a file directly (e.g., `grep "pattern" file`). -**`eval`:** Never use `eval`. +**eval:** Never use `eval`. + +**Logging:** + +- Use single quotes for outputs without variables. +- Use double quotes for outputs with variables. +- Do not finish sentence with a dot if action is following (e.g. `"Backup file"`). +- Finish sentence with a dot if echo is after action (e.g. `"Backup finished."`). \ No newline at end of file diff --git a/AGENTS.md.template b/AGENTS.md.template index 195e656..d089a34 100644 --- a/AGENTS.md.template +++ b/AGENTS.md.template @@ -82,4 +82,11 @@ The following guideline is heavily based on the [Bash Style Guide | ysap.sh](htt - Use globbing (`*`) to iterate over files, not `ls`. - Avoid `cat` when a command can read a file directly (e.g., `grep "pattern" file`). -**`eval`:** Never use `eval`. +**eval:** Never use `eval`. + +**Logging:** + +- Use single quotes for outputs without variables. +- Use double quotes for outputs with variables. +- Do not finish sentence with a dot if action is following (e.g. `"Backup file"`). +- Finish sentence with a dot if echo is after action (e.g. `"Backup finished."`). \ No newline at end of file