JIRA Smart Commit (VS Code Extension)

Automate your engineering workflow with JIRA context and AI.

Generate high-quality Conventional Commits, structured PR Descriptions, and optimized Copilot Prompts directly from your JIRA tickets and staged changes.

🚀 Quick Start

Follow the full engineering lifecycle: Plan → Develop → Review.

1. Plan: Generate First Prompt

Transform a JIRA ticket into a structured prompt for GitHub Copilot to kickstart your development.

1. Checkout a branch with a JIRA key (e.g., feature/PROJ-123-user-login).
2. Run command: JIRA Smart Commit: Generate First Prompt.
3. The extension fetches the ticket details and creates a context-rich prompt.
4. Result: The prompt is sent to GitHub Copilot Chat (auto-submitted or pasted) to help you plan the implementation.

2. Develop: Smart Commit

Generate a Conventional Commit message based on your staged changes and JIRA context.

1. Stage your changes (git add ...).
2. Run command: JIRA Smart Commit: Commit Now.
3. Review the generated message in the preview dialog.
4. Result: A perfect commit message linked to your JIRA ticket.

   feat(auth): implement login page
   
   Adds the login form with validation and error handling.
   
   Refs: PROJ-123
   

3. Review: PR Description

Create a comprehensive Pull Request description ready for review.

1. Prerequisites (if enabled): Complete Security Review and Test Coverage first.
2. Run command: JIRA Smart Commit: Generate PR Description.
3. The extension analyzes all commits, file changes, and the JIRA ticket.
4. Result: A structured PR description is generated in GitHub Copilot Chat, ready to copy-paste into GitHub/GitLab/Bitbucket.

4. Quality: Enforce Test Coverage

Ensure ≥90% test coverage on all changed code.

1. Run command: JIRA Smart Commit: Enforce Test Coverage.
2. GitHub Copilot automatically detects all changes (last commit + staged + unstaged).
3. Result: A comprehensive test coverage analysis and enforcement plan is generated in Copilot Chat, ensuring all changed lines and branches are covered.

✨ Key Features

⚙️ Configuration

Core Settings

• jiraSmartCommit.jiraKeyPosition: Where to place the JIRA key (footer | subject-prefix | subject-suffix). Default: footer.
• jiraSmartCommit.scopeStrategy: How to detect commit scope (packageJson | folder | auto).
• jiraSmartCommit.fetchRelatedIssues: Fetch subtasks and parent issues for more context.

AI Settings

• jiraSmartCommit.ai.enabled: Enable AI post-processing (Default: false).
• jiraSmartCommit.ai.provider: Choose openai, anthropic, gemini, ollama, azure-openai, moonshot, or team-gateway.
• jiraSmartCommit.ai.model: Select your model (e.g., gpt-5.1, claude-4-5-sonnet, gemini-3-pro-preview, gpt-5.1-codex).
• jiraSmartCommit.ai.baseUrl: Custom endpoint URL (for proxies, Ollama, or Team Gateway).

Team Collaboration

• Repository Config: Create a .jira-smart-commit.json in your root to share settings (templates, rules) with your team.
• Team Gateway: Use a centralized LLM gateway for cost tracking and consistent configuration. See TEAM-GATEWAY-GUIDE.md for setup.
• Usage Tracking: Monitor team usage of commit generation, PR descriptions, and first prompts with optional metadata collection (opt-in with team gateway).
• Pre-commit Hook: Run JIRA Smart Commit: Install Pre-commit Hook to enforce commit standards locally.

Security Review

• Security Analysis: Use JIRA Smart Commit: Review Security to analyze all commits on your current branch for security vulnerabilities.
• Configuration: jiraSmartCommit.security.enabled - Enable/disable security review feature.
• Behavior: Security review analyzes ALL commits on the current branch (no limit, no base branch comparison needed).
• Integration: Uses GitHub Copilot Chat for security analysis. Requires GitHub Copilot to be installed and active.

Test Coverage Enforcement

• Test Coverage Analysis: Use JIRA Smart Commit: Enforce Test Coverage to ensure ≥90% test coverage on all changed code.
• Configuration: jiraSmartCommit.testCoverage.enabled - Enable/disable test coverage enforcement feature.
• Multi-Language Support: Automatically detects and supports Go, Ruby, JavaScript/TypeScript, PHP, and Python.
• Automatic Detection: Infers language, test framework, coverage tools, and base branch automatically.
• Integration: Uses GitHub Copilot Chat for test coverage analysis. Requires GitHub Copilot to be installed and active.
• Customizable: Configure prompt template via jiraSmartCommit.testCoverage.promptTemplate or team config.

PR Description

• Prerequisites Enforcement: Require Security Review and Test Coverage to be completed before generating PR Description (default: enabled).
• Configuration: jiraSmartCommit.pr.requirePrerequisites - Enable/disable prerequisite requirement (default: true).
• Team Config Support: Configure via .jira-smart-commit.json to enforce prerequisites across your team.
• Branch-Specific Tracking: Completion status is tracked per branch, so each branch maintains its own prerequisite state.
• Workflow: Run Security Review and Test Coverage first, then generate PR Description. The extension tracks completion automatically.

🌍 Supported Languages

The extension intelligently detects project structure to infer scopes and types:

🚀 Advanced Usage

Token Allocation Strategy

Control how the AI uses its token budget for commit messages:

• balanced (Default): 40% description, 60% diff.
• prefer-description: 70% description (good for complex logic).
• prefer-diff: 70% diff (good for large refactors).

Commit History Context

The extension can include previous commits for the same ticket in the prompt. This helps the AI understand the progression of work and avoid repeating information.

• jiraSmartCommit.includeCommitHistory: true
• jiraSmartCommit.commitHistoryLimit: 5

📦 Installation & Setup

1. Install the extension from the VS Code Marketplace.
2. Configure JIRA:
   • Set jiraSmartCommit.baseUrl (e.g., https://company.atlassian.net).
   • Set jiraSmartCommit.email.
   • Enter your JIRA API Token when prompted.
3. (Optional) Configure AI:
   • Enable AI in settings.
   • Choose your provider and enter the API Key.

For a detailed guide, see HOW-TO-GUIDE.md.

📝 License

MIT © triwibowo