Skip to main content

How to link commit message with JIRA ticket?

Always prefix your commit message with your JIRA ID for tracking purpose, no matter if you are committing in the feature branch or not. 

Linking git commit messages from Jira tickets is important for several reasons, such as:
  • It creates a traceable link between the code changes and the Jira issues, which can help with tracking the progress, status, and history of the project.
  • It enables the developers and the stakeholders to see the branches, commit messages, and pull requests related to the Jira issues, which can improve the communication and collaboration among the team members.
  • It allows the developers to easily reference and navigate to the Jira issues from BitBucket, which can save time and effort.
It ensures that the code changes are aligned with the requirements and expectations of the users or clients, which can enhance the quality and performance of the software products.

Template

JIRA-ID: Your commit message will come here

Figure 1: Template for commit message

Example

KAT-108: Added screen-share module
This is required because when you merge the feature branch in develop then the all commits gets listed together and it would become difficult to identify the change and which JIRA ID it is associated with.

Note

If you divert from the template then avoid any character prefixed in the JIRA ID otherwise it becomes un-relatable to JIRA, for e.g.,
  • JIRA can not recognise to relate it with associated JIRA ID, if used like these
    • #AFC-241 ⟶ incorrect
    • $AFC-241 ⟶ incorrect
    • AFC_241 ⟶ incorrect
    • AFC241 ⟶ incorrect
    • AFC-241 ⟶ correct
Labels:

Comments

Post a Comment

Popular posts from this blog

Unlock protected blocks in Siemens SIMATIC Step 7

Recently I'd been called by Hindalco's Fabrication Plant division to unlock the protected blocks in Siemens SIMATIC Step 7. They were in need to unlock those blocks since an year because of 1 million Rupees of loss per month. They want to re-program those blocks but it was locked by the man who'd done the setup. From the people working in that department, I came to know that they were trying to call that man (someone from Italy) right here but he's not coming. Actually, what he'd done was that he'd locked some of the blocks and deleted the source file. And Siemens didn't provide any feature to unlock. Department people also told me that even the people working in Siemens don't know how to do it. Being a software engineer I know that any thing can be reverse engineered. So I took up the challenge. How did I unlocked the blocks? The first thing I'd done was searched about this software at Google and read about what is this software all about. Aft...
50 comments
Read more

Launching a Jupyter Notebook with TensorFlow using Docker

This article will walk you through setting up a Jupyter Notebook environment with TensorFlow pre-installed using Docker. Docker allows you to run isolated containerized applications, providing a consistent environment regardless of your underlying operating system. Prerequisites: Docker: Ensure you have Docker installed and running on your system. You can download and install it from the official Docker website ( https://www.docker.com/ ). Steps: Start Docker: Open your Docker application (Docker Desktop for Windows/macOS or the command line if using Linux). Run the Jupyter Notebook container: For macOS/Linux: Open your terminal application and run the following command: docker run -it --rm -p 8888:8888 -v "${PWD}":/home/jovyan/work jupyter/tensorflow-notebook For Windows: Open your Command Prompt application and run the following command: docker run -it --rm -p 8888:8888 -v "%CD%":/home/jovyan/work jupyter/tensorflow-notebook Explanation of the command flags: -...
Post a Comment
Read more

JS: The complete code example of Crypto.js (DES)

For one of the project I was trying to use crypto.js but I found that the Quick-start Guide have some deficiency in terms of library usage. So I am writing it here as a useful note for memory recap. <script src="http://crypto-js.googlecode.com/svn/tags/3.1.2/build/rollups/tripledes.js"></script> <script> var encrypted = CryptoJS.DES.encrypt("The secret message", "secret_key"); var e_msg = encrypted.toString(); console.log(e_msg); var decrypted = CryptoJS.DES.decrypt(e_msg, "secret_key"); var d_msg = decrypted.toString(CryptoJS.enc.Utf8); console.log(d_msg); </script>
4 comments
Read more