菜单
Create well-structured GitHub issues with clear titles, descriptions, and acceptance criteria. Use when filing bugs, requesting features, or structuring issue content.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/laurigates/claude-plugins --skill github-issue-writing命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
Install, configure and troubleshoot MCP servers. Use when adding/enabling servers, editing .mcp.json, fixing OAuth, or when a server runs stale code after an upstream fix.
FinOps snapshot — org billing, workflow stats, cache usage. Use when you want a high-level view of CI spending or workflow health before diving deeper.
GitHub Actions billing, workflow efficiency, and waste analysis at org or repo level. Use when investigating CI/CD costs, wasted runs, or optimizing triggers.
| created | "2026-01-30T00:00:00.000Z" |
| modified | "2026-04-29T00:00:00.000Z" |
| reviewed | "2026-04-29T00:00:00.000Z" |
| name | github-issue-writing |
| description | Create well-structured GitHub issues with clear titles, descriptions, and acceptance criteria. Use when filing bugs, requesting features, or structuring issue content. |
| user-invocable | false |
| allowed-tools | Bash(gh issue *), Bash(gh label *), Bash(gh repo *), Read, Grep, Glob, TodoWrite |
Create well-structured, actionable GitHub issues.
| Use this skill when... | Use the alternative when... |
|---|---|
| Filing a new bug, feature, or chore issue with clear title and acceptance criteria |
Use git-issue to start working on existing issues end-to-end |
| Structuring an issue body with reproduction steps, scope, and definition of done | Use github-issue-autodetect to link existing issues from staged diffs |
Choosing the [Type] Component: Description title format | Use github-pr-title to author the conventional title for the PR that fixes it |
| Designing a feature-request issue before implementation begins | Use git-issue-manage for transfer/pin/lock/develop-branch admin operations |
[Type] Component: Brief description
| Type | Example |
|---|---|
| Bug | [Bug] Auth: Login fails with valid credentials |
| Feature | [Feature] API: Add rate limiting support |
| Docs | [Docs] README: Add installation instructions |
| Chore | [Chore] CI: Update Node.js version |
Guidelines:
## Summary
Brief description of the bug.
## Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. See error
## Expected Behavior
What should happen.
## Actual Behavior
What actually happens.
## Environment
- OS: macOS 14.0
- Browser: Chrome 120
- Version: 2.1.0
## Summary
What this feature does.
## Motivation
Why this is needed. What problem does it solve?
## Proposed Solution
Description of desired behavior.
## Acceptance Criteria
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3
GitHub supports first-class issue types. Use --type when creating issues:
| Type | Use For |
|---|---|
| Bug | Something broken that needs fixing |
| Feature | New functionality request |
| Task | General work item |
Note: Available types depend on repository/org configuration. Use gh issue create --type "Bug" to leverage them.
--body-fileFor any non-trivial body — anything containing backticks, code fences, or multi-line content — use --body-file <path>, never --body "<text>". This applies to all gh commands that accept a body: gh issue create, gh issue edit, gh issue comment, gh pr create, gh pr edit, gh pr comment.
| Body shape | Pattern |
|---|---|
| Trivially short, single line, no backticks | --body "Short text" is fine |
| Contains backticks (inline code, code fences) | --body-file /tmp/body.md — required |
| Multi-line | --body-file /tmp/body.md — required |
Contains shell metacharacters ($, ", ', \) | --body-file /tmp/body.md — required |
Shell-quoted --body strings escape backticks (` becomes \`), breaking inline code spans and triple-backtick code fences in the rendered issue. Bash heredocs interact unpredictably with the agent's argument escaping. Writing the markdown to a file with the Write tool sidesteps shell quoting entirely — the file content is preserved byte-for-byte.
1. Write tool → /tmp/issue-body.md (markdown body, no shell escaping)
2. gh issue create --title "..." --body-file /tmp/issue-body.md
The same --body-file <path> form is supported by every gh command that accepts a body.
# Create issue with a body file (preferred for any non-trivial body)
gh issue create --title "[Bug] Auth: Login fails" --body-file /tmp/issue-body.md
# Trivially short body — inline --body is acceptable
gh issue create --title "[Chore] Bump dep" --body "See renovate PR"
# With labels
gh issue create --title "..." --body-file /tmp/body.md --label "bug" --label "priority: high"
# With assignee
gh issue create --title "..." --body-file /tmp/body.md --assignee "@me"
# With issue type
gh issue create --title "..." --body-file /tmp/body.md --type "Bug"
# As sub-issue of a parent
gh issue create --title "..." --body-file /tmp/body.md
gh api repos/{owner}/{repo}/issues/{parent}/sub_issues -f sub_issue_id={new_id}
# Search before creating
gh issue list --search "login error" --state all
Pick the mechanism that matches the relationship — GitHub surfaces each one differently and only the native APIs trigger "Blocked" badges on project boards.
| Relationship | How to record | Why |
|---|---|---|
| Hard dependency (must happen before) | Native dependencies/blocked_by API — see /git:issue-hierarchy --blocked-by N | Sidebar "Relationships" entry + Blocked badge on boards |
| Composition (part-of scope) | Sub-issue API — see /git:issue-hierarchy --add N | Progress bar on parent, tracked separately from dependencies |
| Soft reference ("related to") | Plain markdown Related to #789 in the body | Cross-link only; no lifecycle coupling |
| Auto-close on merge | Fixes #N / Closes #N footer in commit or PR body | Closes issue when the PR merges |
Do not write Blocks #123 or Blocked by #456 in issue bodies any more —
those strings used to be GitHub's workaround for missing dependency APIs, but
they are no longer parsed. Call /git:issue-hierarchy (or the REST endpoints
at issues/{N}/dependencies/blocked_by) so the relationship shows up in the
sidebar and on project boards.
| Action | Command |
|---|---|
| Create | gh issue create --title "..." --body-file /tmp/body.md |
| Create with type | gh issue create --title "..." --body-file /tmp/body.md --type "Bug" |
| Search | gh issue list --search "keyword" |
| View | gh issue view N |
| Edit body | gh issue edit N --body-file /tmp/body.md |
| Comment | gh issue comment N --body-file /tmp/comment.md |
| Labels | gh label list |
| Context | Command |
|---|---|
| Create issue | gh issue create --title "..." --body-file /tmp/body.md |
| Create with type | gh issue create --title "..." --type "Bug" --body-file /tmp/body.md |
| List labels | gh label list --json name |
| Search issues | gh issue list --search "keyword" --state all --json number,title |
| View issue | gh issue view N --json title,body,labels |
基于 SOC 职业分类
