Skip to content

meghac538/Jira-Prompt

Repository files navigation

Jira AI Prompt Generator

A VS Code extension that generates comprehensive, actionable AI prompts from Jira tickets, including analysis of attachments, design files, and referenced links.

Features

🤖 AI-Powered Prompt Generation

  • Automatically generates detailed AI development prompts from Jira tickets
  • Focuses on business requirements, user stories, and acceptance criteria
  • Includes implementation approach, edge cases, and test scenarios

📎 Comprehensive Attachment Analysis

  • Text Files: Analyzes content of text-based attachments (TXT, MD, CSV, JSON)
  • Design Files: Identifies and categorizes image files, PDFs, and design documents
  • Documents: Recognizes Word docs, PDFs, and other specification documents
  • Smart Categorization: Automatically identifies file types and provides appropriate handling guidance

🔗 Advanced Link Analysis

  • Figma Designs: Extracts file IDs and identifies UI/UX specifications
  • GitHub Issues: Fetches issue details from public repositories when available
  • Confluence Pages: Identifies documentation and requirement sources
  • Google Docs: Recognizes shared documentation and specifications
  • Collaboration Boards: Identifies Miro, Mural, and other workflow tools
  • Project Tools: Categorizes Notion pages, Drive files, and other resources

🎯 Business-Focused Output

  • Extracts actual business requirements without technical assumptions
  • Includes design requirements from attached mockups and Figma files
  • Analyzes related tickets and dependencies
  • Provides clear acceptance criteria and test scenarios

🛠️ Multiple Generation Modes

  • AI Generated: Full AI analysis with OpenAI integration
  • Template Mode: Manual template for offline use
  • Debug Commands: Test Jira connection and environment setup

Requirements

Environment Setup

Create a .env file in your extension directory with the following variables:

JIRA_BASE_URL=https://your-company.atlassian.net
JIRA_EMAIL=your-email@company.com
JIRA_API_TOKEN=your-jira-api-token
OPENAI_API_KEY=your-openai-api-key

Dependencies

  • Node.js and npm
  • Valid Jira account with API access
  • OpenAI API key (optional, for AI-generated prompts)

Extension Commands

This extension contributes the following commands:

  • 🤖 Generate AI Development Prompt: Generate a comprehensive AI prompt with full analysis
  • 📝 Generate Prompt Template (No AI): Create a manual template for offline use
  • 🔧 Test Environment Variables: Verify your .env configuration
  • 🔗 Test Jira Connection: Test your Jira API connection
  • 🎫 Test Jira Ticket Fetch: Test fetching a specific Jira ticket

How It Works

  1. Ticket Analysis: Fetches comprehensive Jira ticket data including:

    • Summary, description, and status
    • All attachments with content analysis
    • Related issues and dependencies
    • Referenced links and external resources
  2. Attachment Processing:

    • Text files: Reads and includes content preview
    • Design files: Identifies visual specifications
    • Documents: Flags for manual review
    • Provides download links and metadata
  3. Link Analysis:

    • Categorizes different types of referenced links
    • Extracts additional context (Figma file IDs, GitHub repo info)
    • Provides specific guidance for manual review
  4. AI Enhancement: Uses OpenAI to generate focused prompts that:

    • Avoid technical assumptions
    • Focus on business requirements
    • Include design and attachment requirements
    • Provide clear implementation guidance

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.


Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
  • Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux)
  • Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets

For more information

Enjoy!

About

VS Code extension for JIRA prompt functionality

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors