Skip to content

Commit d0867a2

Browse files
authored
Clarify gh issue body formatting (#14)
1 parent 42fe4d9 commit d0867a2

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

.codex/skills/gh-issues-repo/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ description: Manage GitHub issues in the current repository using the gh CLI. Us
3131

3232
## Body text inputs (avoid literal \n)
3333

34-
When sending multi-line bodies via CLI, prefer `--body-file -` with a heredoc so newlines render correctly:
34+
**For issue creation and edits, always use `--body-file -` with a heredoc for multi-line text.**
35+
This avoids literal `\n` sequences showing up in GitHub.
3536

3637
```sh
3738
gh issue create --title "..." --body-file - <<'EOF'
@@ -43,7 +44,7 @@ gh issue create --title "..." --body-file - <<'EOF'
4344
EOF
4445
```
4546

46-
If you must inline, use ANSI-C quoting so `\n` is interpreted:
47+
If you must inline (single-line or short comments), use ANSI-C quoting so `\n` is interpreted:
4748

4849
```sh
4950
gh issue comment 123 --body $'Line 1\nLine 2\n'

0 commit comments

Comments
 (0)