Skip to content

netresearch/jira-skill / skills/jira-syntax

jira-syntax

Unverified

Use when writing or formatting Jira descriptions, comments, or any text destined for Jira. Converts Markdown to Jira wiki markup, provides templates (bug reports, feature requests), and validates syntax before submission. Trigger on any Jira content authoring task.

<!-- Managed by agent: keep sections & order; edit content, not structure. Last updated: 2025-12-12 -->
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- SPDX-FileCopyrightText: Netresearch DTT GmbH -->

# AGENTS.md — jira-syntax

Development guide for maintaining templates, references, and validation scripts.

## Overview

Static content skill: templates, reference docs, and a validation script. No runtime dependencies.

## Setup & environment

No special setup. Files are plain text/markdown/shell.

## Build & tests

```bash
# Test validation script
scripts/validate-jira-syntax.sh templates/bug-report-template.md
```

## Code style & conventions

**Templates (`templates/`):**
- Use actual Jira wiki markup, never Markdown
- Include section comments explaining purpose
- Test in real Jira before committing

**References (`references/`):**
- Keep `jira-syntax-quick-reference.md` as single source of truth
- Examples must be copy-pasteable into Jira

**Validation script:**
- Bash with grep patterns
- Should catch common Markdown mistakes

## Security & safety

- No executable code in templates
- No sensitive data in examples

## PR/commit checklist

- [ ] All examples use valid Jira wiki markup
- [ ] Tested in actual Jira instance
- [ ] Updated quick-reference if adding new syntax
- [ ] Validation script catches the patterns

## Good vs. bad examples

**Template changes:**
```
# ✓ Test paste into Jira before commit
# ✓ Update quick-reference if new syntax

# ✗ Assume Markdown works in Jira
# ✗ Add syntax without testing
```

## When stuck

- Paste content into real Jira to verify rendering
- Check official docs: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa

## House rules

- SKILL.md has the user-facing syntax reference
- This file is for maintaining the skill itself

---

**Maintaining this file:** See root `AGENTS.md` for convention reference.
planning-and-task-breakdownaddyosmani/agent-skillsBreaks work into ordered tasks. Use when you have a spec or clear requirements and need to break work into implementable tasks. Use when a task feels too large to start, when you need to estimate scope, or when parallel work is possible.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
screenpipethedotmack/claude-memSearch screen and audio history recorded by Screenpipe and optionally save selected context into claude-mem. Use when the user asks to recall desktop activity, a meeting, or something seen in another app through Screenpipe.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
contact-widgetnexu-io/open-designSelf-contained floating chat widget with welcome screen, social links, meeting button, and message input. Single HTML file, zero dependencies.Stars: 108kUpdated Claude CodeCodexVerifiedInstall
meeting-notesnexu-io/open-designMeeting notes page — title bar with attendees, agenda checklist, decisions block, action items table with owners + dates, and a "next meeting" footer. Use when the brief mentions "meeting notes", "minutes", "1:1 notes", "all-hands recap", or "会议纪要".Stars: 108kUpdated Claude CodeCodexVerifiedInstall