agentleFS
puku0xpuku0x/agent-skills-test/.github/skills/gh-pr/SKILL.md

gh-pr

Skill1 starsChanged 7 months agoMITView on GitHub

Create pull requests with proper title format, description template and project conventions. Use when asked to "create a PR", "create pull request", "open a PR", "submit PR", or when ready to push changes and open PR for review. Automatically formats PR titles with type and scope (feat, fix, docs, etc.), generates description template in Japanese, and uses gh CLI for PR creation.

  • Commits and pushes

4 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when:

    line 13
  2. Distinctive:

    Create a pull request using the GitHub CLI:

    line 72
  3. Very specific:

    Always use a single-quoted heredoc (<<'EOF') for --body to prevent shell interpretation of backticks and special characters:

    line 83
  4. Very specific:

    Always pass --body using "$(cat <<'EOF' ...

    line 119

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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 type and scope in the PR title must be written in English while the description must be written in Japanese. (e.g., feat(frontend): 〜の追加)
  • Enclose file names with extension (i.e., *.md *.json ) in the <description> field with backticks.

References

  • Pull Request Template
  • Pull Request Description Instructions

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.