关于 jira-syntax
面向 Jira wiki markup 编写者的语法参考与校验技能,涵盖常见格式、模板和自动检查。API 操作由配套的 jira-communication 技能处理。
主要功能
- 01Jira wiki markup 语法参考
- 02格式模板与检查清单
- 03脚本校验内容语法
- 04常见错误示例
- 05GitLab 跨项目引用规范
适用场景
- 01撰写 Jira 问题描述
- 02发布前检查 wiki markup
- 03编写缺陷或功能请求模板
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ netresearch/ jira-skill --skill jira-syntax安装后在 Claude Code 中输入/jira-syntax确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdevals/evals.jsonreferences/cross-project-refs.mdjira-syntax-quick-reference.mdscripts/validate-jira-syntax.shtemplates/bug-report-template.mdfeature-request-template.md详细介绍
Jira 语法
Jira wiki 标记语法、模板和验证。对于 API 操作,请使用 jira-communication 技能。
快速语法参考
| Jira 语法 | 用途 | 不是这种写法(Markdown) |
|---|---|---|
h2. Title | 标题 | ## Title |
*bold* | 粗体 | **bold** |
_italic_ | 斜体 | *italic* |
{{code}} | 行内代码 | `code` |
{code:java}...{code} | 代码块 | java ``` |
[text|url] | 链接 | [text](url) |
[PROJ-123] | Issue 链接 | - |
[~username] | 用户提及 | @username |
* item | 项目符号列表 | - item |
# item | 编号列表 | 1. item |
||Header|| | 表格标题行 | |Header| |
完整语法文档请参阅 references/jira-syntax-quick-reference.md。
可用模板
Bug 报告
路径:templates/bug-report-template.md
章节:环境、复现步骤、预期行为/实际行为、错误消息、技术说明
功能请求
路径:templates/feature-request-template.md
章节:概述、用户故事、验收标准、技术方案、成功指标
语法验证
提交到 Jira 前运行:
${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh path/to/content.txt
此验证是发布的前置条件——请单独运行,不要与发布命令串联。
验证清单
- 标题:
h2. Title(句点后有空格) - 粗体:
*text*(单个星号) - 代码块:
{code:language}...{code} - 列表:项目符号使用
*,编号使用# - 链接:
[label|url]或[PROJ-123] - 表格:
||Header||和|Cell| - 颜色:
{color:red}text{color} - 面板:
{panel:title=X}...{panel}
常见错误
| ❌ 错误 | ✅ 正确 |
|---|---|
## Heading | h2. Heading |
**bold** | *bold* |
`code` | {{code}} |
[text](url) | [text|url] |
- bullet | * bullet |
h2.Title | h2. Title |
MR !42(裸 GitLab 引用) | [MR 42|url] 或完整的 group/project!42 — 裸的 !…! 是图片标记 |
开放/提议事项上的 (/) | (x) — (/) 会显示为绿色勾号(已完成);开放事项请使用 (x) |
将 ( ) 用作复选框 | (x) — ( ) 不是宏,会按字面显示 |
审核中待处理步骤上的 (-) 或 (x) | (i) pending: … — (-) 会显示为红色禁止符号;在审核中,(x) 表示失败 |
与 jira-communication 技能集成
工作流:
- 从 jira-syntax 获取模板
- 使用 Jira wiki 标记填写内容
- 使用
${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh验证 - 通过 jira-communication 技能提交
参考资料
references/jira-syntax-quick-reference.md- 完整语法文档 其中包括 向渲染器提问,而不是自行推断:POST /rest/api/1.0/render会返回 Jira 对任意标记生成的 HTML,可在发布前使用。遇到标记语法问题时,请用它确认答案,而不是自行推导。references/cross-project-refs.md- 从 Jira 链接到 GitLab 时使用的 GitLab 跨项目引用约定(group/project!N、group/project#N、group/project@tag)templates/bug-report-template.md- Bug 报告模板templates/feature-request-template.md- 功能请求模板${CLAUDE_SKILL_DIR}/scripts/validate-jira-syntax.sh- 自动语法检查器- Jira 官方 Wiki 标记
评论
支持 Markdown