# Hotfix & Jira Integration - Best Practices

To ensure high-quality insights into engineering health, we rely on clean and consistent metadata across Git and Jira. This document outlines best practices for accurately identifying hotfixes and enabling accurate metrics, such as Hotfix Resolution Rate and Hotfix Rate.  Following these practices will ensure your team’s work is properly tracked and reflected in engineering reports.

### 1. Identify Hotfixes via Pull Request Patterns

We detect hotfix PRs by scanning Git metadata for specific keywords across several fields. This is the primary method for classifying a PR as a hotfix.

#### Recommended Keywords (These can be configured based on your naming convention) :

* hotfix
* hot fix

#### Fields Scanned:

* Label
* Title
* Description
* Branch Name
* Tag

#### 🔍 Examples:

* ***hotfix/fix-auth-bug*** (branch)
*

```
<figure><img src="/files/HVEGLzqQhjQG2vTd4Xly" alt="" width="563"><figcaption></figcaption></figure>
```

* ***Hotfix: Resolve checkout crash*** (title)

<figure><img src="/files/bPFvHfGFsBkFULxspR1p" alt="" width="563"><figcaption></figcaption></figure>

* PR label: ***hotfix***
* Tag: ***v2.1.4-hotfix***
* Commit Message:

<figure><img src="/files/QrXMsFSBtfNvJUzYTPIf" alt=""><figcaption></figcaption></figure>

* The title, description can contain other task level details as well, it doesn’t have to be ONLY the ticket ID\
  For example in the below screenshot “HAT-816” is the jira ticket ID

<figure><img src="/files/05qH3Y5BSivcdXoM20iN" alt="" width="563"><figcaption></figcaption></figure>

### 2. Use Semantic Versioning for Patch Releases

Hotfixes can also be identified using version numbers that follow the semantic versioning format: x.y.z, where z (the patch number) is greater than 0.

This method is optional and must be explicitly enabled.

#### Example:

* PR title: ***Release v1.3.2***
* Branch: ***release/v1.3.2***
* Tag: ***v1.3.2***

### 3. Jira Issue Types – Use Consistent Classification

To link hotfix PRs with Jira issues, we rely on standard Jira issue types.

#### Required Setup:

* Hotfix-related tickets must use the Bug issue type.
* Ensure Jira issue types are configured consistently across teams.

### 4. What to Avoid

The following practices prevent us from generating reliable Jira-linked metrics:

* Using shared or generic Jira accounts
* Assigning issues via custom filters (e.g., using individual developers as an assignee type)
* Inconsistent or missing PR metadata (no hotfix keyword, no version tags, etc.)
* Not using or misusing Jira issue types (e.g. all issues marked as “Task”)

### Why This Matters

When these best practices are followed, you unlock the ability to track and improve:

* Hotfix Resolution Time
* Hotfix Rate
* PR-to-Jira traceability
* Team and user-level accountability metrics


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hivel.ai/best-practices/jira-best-practices/hotfix-and-jira-integration-best-practices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.