home / skills / questnova502 / claude-skills-sync / jira-integration

jira-integration skill

unsafe

This skill validates Jira wiki markup, offers templates, and guides formatting to ensure correct syntax before submitting issues.

npx playbooks add skill questnova502/claude-skills-sync --skill jira-integration

Review the files below or copy the command above to add this skill to your agents.

Files (38)

SKILL.md

2.5 KB

---
name: "jira-syntax"
description: "Jira wiki markup syntax validation, templates, and formatting guidance. Use when: (1) Writing Jira issue descriptions or comments, (2) Converting Markdown to Jira wiki markup, (3) Requesting bug report or feature request templates, (4) Validating Jira syntax before submission, (5) Keywords like 'jira format', 'wiki markup', 'jira syntax', 'format for jira', (6) Ensuring content uses h2./h3. headings instead of Markdown ##, (7) Checking code blocks use {code:lang} not triple backticks, (8) Any task involving Jira text formatting"
---

# Jira Syntax Validation Skill

Provides Jira wiki markup syntax validation, templates, and formatting guidance. For API operations, use the **jira-communication** skill.

## Quick Syntax Reference

| Jira Syntax | Purpose | NOT this (Markdown) |
|-------------|---------|---------------------|
| `h2. Title` | Heading | `## Title` |
| `*bold*` | Bold | `**bold**` |
| `_italic_` | Italic | `*italic*` |
| `{{code}}` | Inline code | `` `code` `` |
| `{code:java}...{code}` | Code block | ``` ```java ``` |
| `[text\|url]` | Link | `[text](url)` |
| `[PROJ-123]` | Issue link | - |
| `[~username]` | User mention | `@username` |
| `* item` | Bullet list | `- item` |
| `# item` | Numbered list | `1. item` |
| `\|\|Header\|\|` | Table header | `\|Header\|` |

See `references/jira-syntax-quick-reference.md` for complete syntax documentation.

## Available Templates

### Bug Report
**Path**: `templates/bug-report-template.md`

Sections: Environment, Steps to Reproduce, Expected/Actual Behavior, Error Messages, Technical Notes

### Feature Request
**Path**: `templates/feature-request-template.md`

Sections: Overview, User Stories, Acceptance Criteria, Technical Approach, Success Metrics

## Syntax Validation

Run before submitting to Jira:
```bash
scripts/validate-jira-syntax.sh path/to/content.txt
```

### Validation Checklist
- [ ] Headings: `h2. Title` (space after period)
- [ ] Bold: `*text*` (single asterisk)
- [ ] Code blocks: `{code:language}...{code}`
- [ ] Lists: `*` for bullets, `#` for numbers
- [ ] Links: `[label|url]` or `[PROJ-123]`
- [ ] Tables: `||Header||` and `|Cell|`
- [ ] Colors: `{color:red}text{color}`
- [ ] Panels: `{panel:title=X}...{panel}`

### Common Mistakes

| ❌ Wrong | ✅ Correct |
|---------|-----------|
| `## Heading` | `h2. Heading` |
| `**bold**` | `*bold*` |
| `` `code` `` | `{{code}}` |
| `[text](url)` | `[text\|url]` |
| `- bullet` | `* bullet` |
| `h2.Title` | `h2. Title` |

## Integration with jira-communication Skill

**Workflow:**
1. Get template from jira-syntax
2. Fill content using Jira wiki markup
3. Validate with `scripts/validate-jira-syntax.sh`
4. Submit via jira-communication scripts (e.g., `uv run scripts/workflow/jira-create.py`)

## References

- `references/jira-syntax-quick-reference.md` - Complete syntax documentation
- `templates/bug-report-template.md` - Bug report template
- `templates/feature-request-template.md` - Feature request template
- `scripts/validate-jira-syntax.sh` - Automated syntax checker
- [Official Jira Wiki Markup](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)

Overview

This skill provides Jira wiki markup syntax validation, ready-to-use templates, and practical formatting guidance for writing issue descriptions and comments. It helps convert Markdown to Jira wiki markup, enforces Jira-specific conventions (headings, code blocks, lists, tables), and includes quick references and templates for bug reports and feature requests.

How this skill works

The skill inspects text for common Markdown-to-Jira mistakes and validates Jira wiki constructs (headings, bold/italic, code blocks, lists, links, tables, panels, colors). It offers templates you can fill and a validation checklist and script to run locally before submission. Use the guidance to convert triple-backtick code blocks to {code:lang} and Markdown headings to h2./h3. formats.

When to use it

Writing Jira issue descriptions or comments and ensuring they render correctly
Converting Markdown content (README, PR notes) into Jira wiki markup
Preparing bug reports or feature requests using provided templates
Validating Jira syntax before creating or updating issues
Checking code blocks, headings, lists, links, and tables follow Jira markup

Best practices

Use h2. and h3. with a space after the period instead of Markdown ##/###
Wrap code blocks with {code:language}...{code} and inline code with {{code}}
Prefer *bold* and _italic_ Jira forms rather than Markdown asterisks or underscores
Format links as [label|url] and reference issues as [PROJ-123]
Run the provided validation script before submitting to catch common mistakes

Example use cases

Convert a Markdown release note into Jira wiki markup for a release ticket
Fill the bug report template with Environment, Steps to Reproduce, and Error Messages
Create a feature request using the feature template: Overview, User Stories, Acceptance Criteria
Validate and fix formatting issues in a long technical comment (tables, panels, colors)
Ensure code samples in an issue use language-tagged {code:java} blocks for proper rendering

FAQ

How do I convert Markdown headings to Jira headings?

Replace Markdown ##/### with h2. or h3. and include a space after the period (e.g., h2. Title).

What replaces triple backtick code fences?

Use {code:language}...{code} for code blocks and {{code}} for inline code.