/install github-issue-writer
Context: The WeBuddhist team (backend, frontend, app devs) uses GitHub issue cards to document API endpoints during integration. Cards must be consistent so any dev can scan them and know: what's the endpoint, what goes in, what comes out, and what can go wrong. This skill generates those cards.
Accepted Inputs:
- OpenAPI/Swagger spec (YAML/JSON) → extract endpoints automatically
- Natural language → "we added a language filter to GET /plans/tags"
- Inline details → method, path, params, response pasted in chat
- Existing issue number → reads via
gh issue viewfor context - Any combination of the above
Instructions:
-
Parse the input. Extract: HTTP method, path, query params, request body, response body, status codes, headers. If info is missing, mark as
[TBD]. -
Pick the card type:
- New endpoint → full card
- Endpoint edit → full card + "Current Behavior" / "Proposed Change" sections after Context
- Backend fix → full card, focus Context on the bug, still include the related endpoint and response so devs know which API surface is affected
-
Generate the card using the template below. Do NOT output any conversational text — output ONLY the formatted markdown so it can be directly copied into GitHub.
-
Show the card to the user for review. Wait for approval before proceeding.
-
After approval, ask for target repo:
- Run:
gh repo list \x3Corg> --limit 50 --json name,description - Show list, user picks
- Run:
-
Ask for project board:
- First check auth scope:
gh auth status— ifprojectscope is missing, tell user to rungh auth refresh -s project - Run:
gh project list --owner \x3Corg> --format json - Show list, user picks
- First check auth scope:
-
Create and link:
gh issue create --repo \x3Corg>/\x3Crepo> --title "\x3Ctitle>" --body "\x3Cbody>"gh project item-add \x3Cproject-number> --owner \x3Corg> --url \x3Cissue-url>- Show the issue URL
Never auto-create. Always: generate → review → repo → board → create.
Card Template:
# \x3CShort clear title>
## Context
\x3C1-2 sentences: why this endpoint exists, or what's changing and why>
## Endpoint
\`\`\`
\x3CMETHOD> \x3Cpath>
\`\`\`
## Headers
| Header | Required | Description |
|--------|----------|-------------|
| `Authorization` | Yes | Bearer token |
## Query Parameters
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
## Request Body
\`\`\`json
{}
\`\`\`
## Response
**200 OK**
\`\`\`json
{}
\`\`\`
## Status Codes
| Code | Description |
|------|-------------|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not found |
| 422 | Validation error |
## Notes
- \x3CEdge cases, gotchas, related issues>
Omit sections that don't apply (e.g., no Request Body for GET, no Query Params for POST with body only).
For endpoint edits, add after Context:
## Current Behavior
## Proposed Change
Prerequisites:
- The
ghtoken needs theprojectscope. If project commands fail, run:gh auth refresh -s project
Rules:
- Realistic example values — Tibetan text for
bofields (སྒོམ), UUIDs for IDs, real names like "Morning Meditation" - Multilingual fields as objects:
{ "en": "Meditation", "bo": "སྒོམ" } - OpenAPI schemas → concrete JSON examples, not raw schema
- Short scannable notes — bullets, not paragraphs
[TBD]for unknowns, never invent behavior- Always ask user to pick repo and project board
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install github-issue-writer - 安装完成后,直接呼叫该 Skill 的名称或使用
/github-issue-writer触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
GithubIssue 是什么?
Generate structured GitHub issue cards for the WeBuddhist team. Use this when a backend dev needs to document a new or changed endpoint, or when a frontend/a... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 205 次。
如何安装 GithubIssue?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install github-issue-writer」即可一键安装,无需额外配置。
GithubIssue 是免费的吗?
是的,GithubIssue 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
GithubIssue 支持哪些平台?
GithubIssue 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 GithubIssue?
由 Tech-lo(@tech-lo)开发并维护,当前版本 v1.0.0。