| name | pr-creator |
| description | Use this skill when asked to create a pull request (PR). It creates a new branch, commits with detailed Traditional Chinese (zh-TW) messages, enriches the related issue with technical context and problem definition, then creates a PR with a zh-TW description. |
Pull Request Creator
This skill guides the creation of high-quality Pull Requests. All user-facing
output (commit messages, PR descriptions, issue comments) MUST be written in
Traditional Chinese (zh-TW). The skill document itself is in English.
Workflow
Follow these steps in order to create a Pull Request:
1. Create a New Branch
CRITICAL: NEVER work directly on the main branch.
2. Analyze Changes
Before committing, thoroughly analyze all changes to produce high-quality commit
messages:
- Run
git diff --stat and git diff to understand all changed files.
- Identify and summarize:
- Problem definition: What problem does this change solve?
- Technical context: Why this approach? What alternatives were considered?
- Impact scope: Which modules / features are affected?
- Breaking changes: Are there any?
3. Commit in Traditional Chinese
All commit messages MUST be written in Traditional Chinese (zh-TW), using
the following format:
git add .
git commit -m "type(scope): 簡短摘要
詳細說明：
- 變更項目 1：說明具體修改內容與原因
- 變更項目 2：說明具體修改內容與原因
技術細節：
- 採用的技術方案與理由
- 相關的設計決策
影響範圍：
- 受影響的模組或功能
- 是否有破壞性變更"
- type: Use English (feat / fix / refactor / docs / chore / test)
- scope: Use English module name
- Summary and body: Must be in Traditional Chinese
- The commit body should be detailed enough that a reviewer can understand the
full context without reading the code
4. Enrich the Related Issue
If this PR is linked to an issue, update the issue with technical context
before creating the PR:
5. Locate PR Template
Search the repository for a Pull Request template:
- Check
.github/pull_request_template.md
- Check
.github/PULL_REQUEST_TEMPLATE.md
- If multiple templates exist (e.g., in
.github/PULL_REQUEST_TEMPLATE/),
select the most appropriate one based on the change type.
- If no template is found, use the default structure in Step 6.
6. Draft PR Description
The PR description MUST be in Traditional Chinese. Follow the template
structure strictly. If no template exists, use the following default:
## 概述
（一段話說明這個 PR 做了什麼）
## 問題描述
（這個 PR 要解決什麼問題？連結相關 Issue）
## 解決方案
（採用了什麼技術方案？為什麼？）
## 變更內容
- [ ] 變更項目 1
- [ ] 變更項目 2
## 測試方式
（如何驗證這些變更是正確的？）
## 相關連結
- Issue: #xxx
- 相關文件：...
7. Push Branch
Safety check: Verify the branch name one more time before pushing.
CURRENT_BRANCH=$(git branch --show-current)
if [ "$CURRENT_BRANCH" = "main" ]; then
echo "ERROR: must not push to main!"
exit 1
fi
git push -u origin HEAD
8. Create the PR
Use the gh CLI to create the PR. To avoid shell escaping issues with
multi-line Markdown, write the description to a temporary file first:
cat > /tmp/pr-body.md << 'EOF'
(PR description content in zh-TW)
EOF
gh pr create \
--title "type(scope): 繁體中文簡短摘要" \
--body-file /tmp/pr-body.md
rm /tmp/pr-body.md
- Title format:
type(scope): 繁體中文摘要
- If linked to an issue, include
Fixes #xxx in the body and add --assignee @me
Principles
- Safety First: NEVER push to
main. This is the highest priority rule.
- Traditional Chinese Output: All commit messages, PR descriptions, and
issue comments MUST be in Traditional Chinese (zh-TW).
- Full Context: Commits and PRs must provide enough technical context for
reviewers to understand changes quickly.
- Issues as Documentation: Issues are permanent technical decision records,
not just task trackers. Enrich them accordingly.
- Honesty: Don't check boxes for tasks you haven't completed.
