pr-creator

Files (1)

• SKILL.md

SKILL.md (first lines)

# 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.

- Run `git branch --show-current` to check the current branch.
- If on `main`, create and switch to a new descriptive branch:
  ```bash
  git checkout -b feat/<short-description>
  ```
- Branch naming convention: `feat/xxx`, `fix/xxx`, `refactor/xxx`, `docs/xxx`

### 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:

```bash
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:

- Read the existing issue with `gh issue view <issue_number>`.
- Add a comment with `gh issue comment <issue_number> --body "..."` containing:
  ```markdown
  ## 技術分析

  ### 問題根因
  （說明問題的根本原因，不只是表面症狀）

  ### 解決方案
  （說明採用的技術方案與原因）

  ### 影響評估
  - 受影響的模組：...
  - 破壞性變更：有 / 無
  - 效能影響：...

  ### 測試驗證
  （說明如何驗證修改是正確的）
  ```
- This ensures the issue serves as a complete technical record, not just a
  one-line description.

### 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:

```markdown
## 概述
（一段話說明這個 PR 做了什麼）

## 問題描述
（這個 PR 要解決什麼問題？連結相關 Issue）

## 解決方案
（採用了什麼技術方案？為什麼？）

## 變更內容
- [ ] 變更項目 1
- [ ] 變更項目 2

## 測試方式
（如何驗證這些變更是正確的？）

From duotify/GitHubClawToolkit, MIT.

More from duotify/GitHubClawToolkit