Git Product home page Git Product logo

jira-commit-message's Introduction

Jira Commit Message Extension for VSCode

This VSCode extension automatically prefixes commit messages with a Jira issue code extracted from the branch name. Developed in hopes to make the process of dealing with Jira a tiny bit less annoying.

Features

  • Automatic Prefixing: Automatically adds a Jira issue code as a prefix to commit messages based on the current branch name.
  • Customizable Patterns: Allows for custom configuration of the issue code extraction pattern and commit message format.
  • Outdated Prefix Handling: Detects and updates outdated prefixes in commit messages when the branch changes.

Configuration

Customize the extension behavior via the following settings in your VSCode settings.json:

  • commitMessagePrefixPattern: Regex pattern to match issue prefixes in branch names. Default is (ML-\d+)-.*.
  • commitMessageFormat: Format for the commit message. Use ${prefix} for the branch prefix and ${message} for the original commit message. Default is "[${prefix}] ${message}".
  • gitHeadWatchInterval: Interval in milliseconds to watch the .git/HEAD file for changes. Default is 1000.

Usage

Once installed, the extension automatically watches for branch changes and updates the commit message input in VSCode's Source Control panel according to the configured patterns.

Installation

Install the extension directly from the Visual Studio Code Marketplace:

  1. Open VSCode.
  2. Navigate to Extensions by clicking on the square icon on the sidebar or pressing Ctrl+Shift+X.
  3. Search for "Jira Commit Message".
  4. Click on "Install".

Alternatively, you can install it via the VSCode Marketplace website.

Contributing

Contributions are welcome! Please submit pull requests with any enhancements, bug fixes, or suggestions.

License

This project is licensed under the MIT License - see the LICENSE file for details.

jira-commit-message's People

Contributors

kivicode avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.