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

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

Openmeetings Widget Wordpress Plugin

One of my client asked me to create a Wordpress plugin, so the first thing I did was to search for any existing plugin on which I can work on. Luckily I found one. It was developed by Shuki Vaknin. You can visit his plugin at:  http://wordpress.org/extend/plugins/openmeetings-integration-plugin-widget/ But I had little different requirement. So I modified the Shuki Vaknin's plugin. The modification is that every session has a unique username. I choose guest as default name while adding a timestamp along with guest keyword like guest34578689 . Download Link:  openmeetings-integration-plugin-widget.zip
6 comments
Read more