docs: add GitHub comment formatting/linking guardrails

This commit is contained in:
Peter Steinberger
2026-02-23 19:17:33 +00:00
parent 47723b646d
commit 2931e215ca

View File

@@ -2,6 +2,8 @@
- Repo: https://github.com/openclaw/openclaw
- GitHub issues/comments/PR comments: use literal multiline strings or `-F - <<'EOF'` (or $'...') for real newlines; never embed "\\n".
- GitHub comment footgun: never use `gh issue/pr comment -b "..."` when body contains backticks or shell chars. Always use single-quoted heredoc (`-F - <<'EOF'`) so no command substitution/escaping corruption.
- GitHub linking footgun: dont wrap issue/PR refs like `#24643` in backticks when you want auto-linking. Use plain `#24643` (optionally add full URL).
## Project Structure & Module Organization