[JIRA] Tracability from commits

Vincent Massol vincent at massol.net
Tue Apr 24 09:49:46 CEST 2007


Hi committers,

I see that we're now quite good at putting jira references in our  
first commits. That's good! However sometimes when we make a mistake,  
or forget something to commit, we don't put again the reference to  
the JIRA issue in the subsequent commits.

It would be better if we were always putting the reference to JIRA.  
For example, I fixed something related to XWIKI-49 this morning and I  
used the following format:

"
XWIKI-49: PDF generation failed with vietnamese characters encoded in  
UTF-8

* Replaced SNAPSHOT by a timestamped version so that the build can be  
reproduced and so that we can perform a release of RC2 tomorrow.
* Moved out the JTidy <dependency> as it was now wrongly in the  
"custom xwiki repository" section.
* Removed JTidy from our custom XWiki repository
"

Why do we need this?

Because it then makes it very easy later on to find what happened  
related to a JIRA issue. We had this need for example when we were  
trying to find out the difference between 2 branches (you may  
remember, I spent a whole day on that a month ago). Thanks to the  
Subversion plugin in JIRA we can see what happens related to an  
issue. For example:

http://jira.xwiki.org/jira/browse/XWIKI-49? 
page=com.atlassian.jira.plugin.ext.subversion:subversion-commits- 
tabpanel

However that only works if we have put a reference to the jira issue  
in the commit log.

Thanks
-Vincent





More information about the devs mailing list