format-github-issue

Format GitHub issue titles and bodies into Markdown for gh commands.

Updated Jun 4, 2025
One-click install
npx skills add https://github.com/alexei-lexx/budget --skill format-github-issue
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: format-github-issue
Source: https://github.com/alexei-lexx/budget/tree/main/.claude/skills/format-github-issue
Command: npx skills add https://github.com/alexei-lexx/budget --skill format-github-issue

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams ensure GitHub issues are consistently worded and structured, reducing miscommunication and increasing issue visibility and triage speed.

Core Features & Use Cases

  • Classifies issue type (Feature, Bug, Technical/Refactoring, Simple Task) to guide the structure.
  • Formats titles to follow conventions (lowercase with proper nouns/acronyms; action verb for non-bug issues) and ensures concise, specific wording.
  • Produces a ready-to-submit body template for gh issue create / gh issue edit, including sections like context, solution, acceptance criteria, user flow, and UI behavior as appropriate.

Quick Start

Provide the issue title and body you want formatted, and the skill will output a polished, ready-to-submit version.

Frequently Asked Questions about format-github-issue

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format GitHub issue titles and descriptions to follow project conventions?

Formatting GitHub issues involves classifying the issue type, applying lowercase casing with action verbs to titles, and structuring body sections like context and acceptance criteria to produce ready-to-submit Markdown for gh issue create or gh issue edit.

What is the best way to structure a GitHub bug report or feature request?

Structuring a bug report or feature request requires classifying the issue type first, then generating a Markdown body with appropriate sections like context, solution, acceptance criteria, user flow, and UI behavior based on that classification.

Can I use this to prepare issues for the gh issue create command?

Yes, you can prepare issues for the gh issue create command. The process outputs a deterministic, ready-to-submit Markdown format for titles and bodies that integrates directly with GitHub CLI workflows like gh issue create or gh issue edit.

Does this approach work for both technical refactoring tasks and simple wording improvements?

Yes, this approach works for both technical refactoring tasks and simple wording improvements. It handles issue types including features, bugs, technical refactoring, and simple tasks, adjusting title casing and body structure accordingly.

Why do my GitHub issue titles lack consistent wording and structure across a project?

GitHub issue titles lack consistent wording when project conventions are not enforced. This is resolved by applying a deterministic workflow that formats titles with proper lowercase casing, acronyms, and action verbs based on the classified issue type.