How do I validate Jira syntax?

Run scripts/validate-jira-syntax.sh path/to/content.txt to check for common syntax issues before submission.

Which templates are available?

Bug Report and Feature Request templates are available under templates (e.g., templates/bug-report-template.md and templates/feature-request-template.md).

How do I integrate with jira-communication?

Follow the workflow: get content from jira-syntax, fill with Jira wiki markup, validate, then submit via jira-communication scripts (e.g., uv run scripts/workflow/jira-create.py).

jira-syntax

Scanned

npx machina-cli add skill netresearch/jira-skill/jira-syntax --openclaw

Files (1)

SKILL.md

2.8 KB

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:

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:

Get template from jira-syntax
Fill content using Jira wiki markup
Validate with scripts/validate-jira-syntax.sh
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

Source

git clone https://github.com/netresearch/jira-skill/blob/main/skills/jira-syntax/SKILL.mdView on GitHub

Overview

Jira Syntax Validation Skill provides Jira wiki markup syntax validation, ready-made templates for common issues, and guidance for formatting Jira content. It helps convert Markdown to Jira syntax and ensures descriptions or comments are submission-ready. For API operations, use the jira-communication skill.

How This Skill Works

The skill offers a quick syntax reference, templates for Bug Reports and Feature Requests, and a script-based validator (scripts/validate-jira-syntax.sh) to check content before submission. It integrates guidance on formatting and provides paths to templates and validation tools to streamline Jira content creation.

When to Use It

Writing Jira descriptions or comments
Converting Markdown to Jira wiki markup
Using templates for Bug Reports or Feature Requests
Validating Jira syntax before submitting content
Coordinating with jira-communication to submit Jira issues

Quick Start

Step 1: Draft content using Jira wiki markup and the provided templates
Step 2: Validate with scripts/validate-jira-syntax.sh path/to/content.txt
Step 3: Submit via jira-communication scripts (e.g., uv run scripts/workflow/jira-create.py)

Best Practices

Follow the Quick Syntax Reference: use h2. for headings, *bold* for bold, {{code}} for inline code
Use the provided templates (Bug Report, Feature Request) and fill all sections
Run scripts/validate-jira-syntax.sh path/to/content.txt before submission
Use Jira-style links: [label|url] or [PROJ-123] for issue references
Ensure lists and tables use Jira markup (Bullet: * , Numbered: #, Tables: ||Header|| and |Cell|)

Example Use Cases

Drafting a bug report using the Bug Report template and populating Environment, Steps to Reproduce, and Expected/Actual Behavior
Creating a feature request with the Feature Request template, including Overview and Acceptance Criteria
Formatting a Jira description with h2 headings, bold text, and inline code using {{code}}
Running the validator: scripts/validate-jira-syntax.sh path/to/content.txt to catch syntax issues
Linking to a Jira issue with [PROJ-123] and mentioning a teammate with [~username]

Frequently Asked Questions

Add this skill to your agents