|
Home > Archive > Apache Mod-Python > February 2006 > Maually adding notes about commits to JIRA.
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Maually adding notes about commits to JIRA.
|
|
| Graham Dumpleton 2006-02-19, 5:45 pm |
| Jim Gallacher wrote ..
> Graham,
>
> I don't think it's necessary to add an additional JIRA comment when you
> commit some code. JIRA will pickup the svn commit as long as the issue
> number is mentioned in the svn commit message. People can subscribe to
> python-cvs if they want notification of the commits.
>
> This should save you a bit of work. 
>
> Jim
Looking at the bigger picture, I believe that adding the comment to JIRA
explicitly saves me work down the track.
Where I am coming from is the perspective of a user who has started
using mod_python recently and is having a problem. For myself, I find it
quite annoying when looking at other third party packages when
investigating an issue and find the problem mentioned in a issue
tracking system, but then find that it hasn't been updated in a while
and thus looks like the software is still broken and isn't about to be
fixed. Often one digs further though and finds that it was actually
fixed some time back, but because the issue tracking system was never
updated to at least mention that it was fixed in the repository you
never actually know this. The average person is not going to want to
subscribe to some special mailing list to find out about repository
commits for a package they have only just started to use. Even if one
did this, you aren't going to find out about what has happened in the
past from the mailing list. Thus to me, the JIRA system is perfect for
recording a full and complete history of what has happened that people
can refer to. The only problem at the moment is that the JIRA system
still isn't linked from the mod_python home page so people never
find it in the first place.
So overall I feel it saves me work as people will either find the information
themselves and know that if they simply check out latest source code that
they will get the fix, or at worst I can respond to questions on the mailing
list with a quick link to the JIRA issue and not have to reiterate the same
information all over again.
I also feel that identifying the revision may be helpful when someone
wants to perhaps backport changes to an older version. This may be us,
or someone who needs to do it for themselves.
Graham
[vbcol=seagreen]
> Graham Dumpleton (JIRA) wrote:
> ]
> writable commited into mod_python SVN trunk in revsion 378864.
| |
| Jim Gallacher 2006-02-19, 5:45 pm |
| Graham Dumpleton wrote:
> Jim Gallacher wrote ..
>
>
>
> Looking at the bigger picture, I believe that adding the comment to JIRA
> explicitly saves me work down the track.
>
> Where I am coming from is the perspective of a user who has started
> using mod_python recently and is having a problem. For myself, I find it
> quite annoying when looking at other third party packages when
> investigating an issue and find the problem mentioned in a issue
> tracking system, but then find that it hasn't been updated in a while
> and thus looks like the software is still broken and isn't about to be
> fixed. Often one digs further though and finds that it was actually
> fixed some time back, but because the issue tracking system was never
> updated to at least mention that it was fixed in the repository you
> never actually know this. The average person is not going to want to
> subscribe to some special mailing list to find out about repository
> commits for a package they have only just started to use. Even if one
> did this, you aren't going to find out about what has happened in the
> past from the mailing list. Thus to me, the JIRA system is perfect for
> recording a full and complete history of what has happened that people
> can refer to. The only problem at the moment is that the JIRA system
> still isn't linked from the mod_python home page so people never
> find it in the first place.
>
> So overall I feel it saves me work as people will either find the information
> themselves and know that if they simply check out latest source code that
> they will get the fix, or at worst I can respond to questions on the mailing
> list with a quick link to the JIRA issue and not have to reiterate the same
> information all over again.
>
> I also feel that identifying the revision may be helpful when someone
> wants to perhaps backport changes to an older version. This may be us,
> or someone who needs to do it for themselves.
>
All very interesting, except that JIRA does record the svn commit info,
and with great detail. It just doesn't treat the commit as a comment.
For example:
http://issues.apache.org/jira/brows...ON-124?page=all
Personally I think the Subversion commit information should be included
in the comments by default, rather than requiring a separate view, but I
guess that's between JIRA and myself.
Jim
| |
| Graham Dumpleton 2006-02-19, 5:45 pm |
| Jim Gallacher wrote ..
> All very interesting, except that JIRA does record the svn commit info,
> and with great detail. It just doesn't treat the commit as a comment.
>
> For example:
> http://issues.apache.org/jira/brows...ON-124?page=all
>
> Personally I think the Subversion commit information should be included
> in the comments by default, rather than requiring a separate view, but
> I
> guess that's between JIRA and myself.
This is showing my ignorance then. That the commit appeared there was
a fluke on my part. I was not aware that it was able to tie the commit message
to the JIRA issue. I do not recollect seeing the commits there when I added
the comment, perhaps because I had the issue up already before doing
the commit. :-(
What is the magic then? Is it purely because I had listed MODPYTHON-124
in the commit message. Where is that documented? Did a quick scan of
dev.apache.org I haven't found mention of it yet.
Graham
| |
| Jim Gallacher 2006-02-19, 5:45 pm |
| Graham Dumpleton wrote:
> Jim Gallacher wrote ..
>
>
>
> This is showing my ignorance then. That the commit appeared there was
> a fluke on my part. I was not aware that it was able to tie the commit message
> to the JIRA issue. I do not recollect seeing the commits there when I added
> the comment, perhaps because I had the issue up already before doing
> the commit. :-(
There can be a bit of a time lag, so it may not have been there when you
added your comment.
> What is the magic then? Is it purely because I had listed MODPYTHON-124
> in the commit message.
Yep. That's the magic.
Where is that documented? Did a quick scan of
> dev.apache.org I haven't found mention of it yet.
I have no idea where it's documented. Likely in the JIRA help pages, but
it was Nicolas that first informed me of this feature. I'll add this
information to my developer guidelines page.
Jim
|
|
|
|
|