feat(agents-guide): add logging guidelines for quote usage and sentence punctuation
This commit is contained in:
2 files changed
+16
-2
No files matched your search
@@ -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."`).
|
||||
+8
-1
@@ -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."`).
|
||||
Reference in new issue
Block a user