puku0x GitHub Pull Request Creation Skill
This skill guides the creation of GitHub pull requests following project-specific conventions.
When to Use
Use this skill when:
- Ready to create a pull request for review
- Need to push branch to remote and open PR
Format of pull request
A pull request consists of a title and a description.
Format of PR title
The PR title follows this format:
<type>[optional scope]: <description>
<type>and[optional scope]follow the same format as commit messages<description>must be written in Japanese<description>must end with a noun
Format of PR description
The PR description should be written in Japanese and follow this template:
## 概要
<!-- （修正の内容など） -->
- [ ] 変更内容 1
- [ ] 変更内容 2
- [ ] 不具合修正の内容
## 備考
<!-- （関連Issueなど） -->
- #123
Instructions
Step 1: Push to remote
Get the current branch name:
git branch --show-current
Push the current branch to the remote repository:
git push -u origin <current-branch-name>
Step 2: Create a pull request
Create a pull request using the GitHub CLI:
gh pr create --title '<PR title>' --body "$(cat <<'EOF'
<PR description>
EOF
)"
Example
Always use a single-quoted heredoc (<<'EOF') for --body to prevent shell interpretation of backticks and special characters:
gh pr create --title 'docs(github): カスタムインストラクションの追加' --body "$(cat <<'EOF'
## 概要
GitHub Copilot 用のカスタムインストラクションを追加しました。
### 変更内容
- [x] `.github/custom-instructions.md` の追加
- [x] `.github/instructions/*.md` の追加
## 備考
- #123
EOF
)"
--title: Use single quotes or escape backticks
Backticks inside a double-quoted string are interpreted as command substitution by the shell. Use one of the following approaches when the title contains backtick-wrapped file names:
# Option 1: wrap the entire title in single quotes (recommended)
--title 'chore(vscode): `settings.json` 更新'
# Note: single quotes prevent ALL shell interpretation,
# so $variables and `commands` inside will not be expanded.
# Option 2: escape each backtick
--title "chore(vscode): \`settings.json\` 更新"
--body: Always use a single-quoted heredoc
Always pass --body using "$(cat <<'EOF' ... EOF)".
Inside a heredoc with a single-quoted delimiter (<<'EOF'), the shell performs no variable expansion or command substitution. This allows you to include backticks and other special characters in the PR description without needing to escape them.
# Good: backticks inside <<'EOF' are literal
--body "$(cat <<'EOF'
`settings.json` を更新しました。
EOF
)"
# Bad: backticks inside double quotes trigger command substitution
--body "`settings.json` を更新しました。"
# ↑ shell tries to run `settings.json` as a command → error
Notes
- Important The
typeandscopein the PR title must be written in English while thedescriptionmust be written in Japanese. (e.g.,feat(frontend): 〜の追加) - Enclose file names with extension (i.e.,
*.md*.json) in the<description>field with backticks.