You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@isis.apache.org by Dan Haywood <dk...@gmail.com> on 2011/07/17 18:23:46 UTC

commit messages and JIRA

Now that we have a first release out, I'd like to ensure that there's 
some traceability in changes being made...   That way we can be sure 
that our release notes for subsequent releases will be reasonably 
comprehensive, as well as meaning that users will gain confidence in us 
as being a properly-run project.

So, what I'd like to propose that any commits that we do to the codebase 
are cross-referenced to a JIRA ticket.  For example, if working on 
ISIS-105, then the commit message should be something like: "ISIS-105: 
sorted out formatting".

Opinions?

Thanks
Dan


Re: commit messages and JIRA

Posted by Henry Saputra <he...@gmail.com>.
+1 for this plan

- Henry

On Sun, Jul 17, 2011 at 9:23 AM, Dan Haywood <dk...@gmail.com> wrote:
> Now that we have a first release out, I'd like to ensure that there's some
> traceability in changes being made...   That way we can be sure that our
> release notes for subsequent releases will be reasonably comprehensive, as
> well as meaning that users will gain confidence in us as being a
> properly-run project.
>
> So, what I'd like to propose that any commits that we do to the codebase are
> cross-referenced to a JIRA ticket.  For example, if working on ISIS-105,
> then the commit message should be something like: "ISIS-105: sorted out
> formatting".
>
> Opinions?
>
> Thanks
> Dan
>
>

Re: commit messages and JIRA

Posted by Robert Matthews <rm...@nakedobjects.org>.
Nour,

This looks rather nice, but I can't seem to look at the changes over a 
number of revisions - just those for a specific revision.  Do you know 
if this is possible?

Rob

On 19/07/11 19:51, Mohammad Nour El-Din wrote:
> Here you are http://support.atlassian.com/browse/FSH-6399
>
> On Tue, Jul 19, 2011 at 7:46 PM, Mohammad Nour El-Din
> <no...@gmail.com>  wrote:
>> Pingo, please have a look at [1] and [2]. Let me handle it.
>>
>> [1] - https://fisheye6.atlassian.com/
>> [2] - https://fisheye6.atlassian.com/browse
>>
>> On Tue, Jul 19, 2011 at 7:30 PM, Mohammad Nour El-Din
>> <no...@gmail.com>  wrote:
>>> Hi...
>>>
>>>    I remember that this topic has been discussed before but I can't
>>> remember when and where. Let me check on that.
>>>
>>> On Tue, Jul 19, 2011 at 4:06 PM, Kevin Meyer<ke...@kmz.co.za>  wrote:
>>>> Hi Rob,
>>>>
>>>> Indeed, that is a nice view into the change-set.
>>>>
>>>> The web-based svn browser Apache uses only supports diff views of
>>>> individual files, with no obvious "entire commit" view.
>>>>
>>>> I'm with you on this one..
>>>>
>>>> Dan, btw, what did you do to link your commit to the JIRA view of ISIS-107?
>>>>
>>>> Regards,
>>>> Kevin
>>>>
>>>>
>>>> On Tue, July 19, 2011 14:19, Robert Matthews wrote:
>>>>> I'm all for that (+1).  What happens for other changes - reforactorings
>>>>> or small incremental improvements?
>>>>>
>>>>> While we are talking about change, I'm missing Trac terribly, and
>>>>> specifically its view of the code base and most importantly its ability
>>>>> to view the difference between revisions (see the original codebase ...
>>>>> for an example).  This has helped me tremedously so many time to see
>>>>> where changes are taking place and what has happened.
>>>>
>>>>> Is there anything similar in Apache? Does anyone know of other similar
>>>>> tools (the source browsing/diffing part) that we could make use of?
>>>>> (While Trac will allow you to use a mirrored repository I don't think
>>>>> this would work with Isis as the repo is shared with all the other
>>>>> projects - ie its too big!)
>>>>>
>>>>> Regards
>>>>> Rob
>>>>
>>>>
>>>
>>>
>>> --
>>> Thanks
>>> - Mohammad Nour
>>>    Author of (WebSphere Application Server Community Edition 2.0 User Guide)
>>>    http://www.redbooks.ibm.com/abstracts/sg247585.html
>>> - LinkedIn: http://www.linkedin.com/in/mnour
>>> - Blog: http://tadabborat.blogspot.com
>>> ----
>>> "Life is like riding a bicycle. To keep your balance you must keep moving"
>>> - Albert Einstein
>>>
>>> "Writing clean code is what you must do in order to call yourself a
>>> professional. There is no reasonable excuse for doing anything less
>>> than your best."
>>> - Clean Code: A Handbook of Agile Software Craftsmanship
>>>
>>> "Stay hungry, stay foolish."
>>> - Steve Jobs
>>>
>>
>>
>> --
>> Thanks
>> - Mohammad Nour
>>    Author of (WebSphere Application Server Community Edition 2.0 User Guide)
>>    http://www.redbooks.ibm.com/abstracts/sg247585.html
>> - LinkedIn: http://www.linkedin.com/in/mnour
>> - Blog: http://tadabborat.blogspot.com
>> ----
>> "Life is like riding a bicycle. To keep your balance you must keep moving"
>> - Albert Einstein
>>
>> "Writing clean code is what you must do in order to call yourself a
>> professional. There is no reasonable excuse for doing anything less
>> than your best."
>> - Clean Code: A Handbook of Agile Software Craftsmanship
>>
>> "Stay hungry, stay foolish."
>> - Steve Jobs
>>
>
>

Re: commit messages and JIRA

Posted by Robert Matthews <rm...@nakedobjects.org>.
Dan

The other links Nour provided show you what it can do.

On 20/07/11 07:45, Dan Haywood wrote:
>
> On 19/07/2011 19:51, Mohammad Nour El-Din wrote:
>> Here you are http://support.atlassian.com/browse/FSH-6399
> I can't seem to browse to that URL... I get a permission violation 
> (even once I've signed up onto their system).
>
> What is that URL exactly?  I'm guessing it's a request to setup 
> Fisheye for our Isis repository?
>
> Dan
>

Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
I think you can't I am sorry, but this is something related to
Atlassian JIRA thingy. I will be updating you all in this thread.

On Wed, Jul 20, 2011 at 8:45 AM, Dan Haywood <dk...@gmail.com> wrote:
>
> On 19/07/2011 19:51, Mohammad Nour El-Din wrote:
>>
>> Here you are http://support.atlassian.com/browse/FSH-6399
>
> I can't seem to browse to that URL... I get a permission violation (even
> once I've signed up onto their system).
>
> What is that URL exactly?  I'm guessing it's a request to setup Fisheye for
> our Isis repository?
>
> Dan
>
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Dan Haywood <dk...@gmail.com>.
On 19/07/2011 19:51, Mohammad Nour El-Din wrote:
> Here you are http://support.atlassian.com/browse/FSH-6399
I can't seem to browse to that URL... I get a permission violation (even 
once I've signed up onto their system).

What is that URL exactly?  I'm guessing it's a request to setup Fisheye 
for our Isis repository?

Dan


Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
Here you are http://support.atlassian.com/browse/FSH-6399

On Tue, Jul 19, 2011 at 7:46 PM, Mohammad Nour El-Din
<no...@gmail.com> wrote:
> Pingo, please have a look at [1] and [2]. Let me handle it.
>
> [1] - https://fisheye6.atlassian.com/
> [2] - https://fisheye6.atlassian.com/browse
>
> On Tue, Jul 19, 2011 at 7:30 PM, Mohammad Nour El-Din
> <no...@gmail.com> wrote:
>> Hi...
>>
>>   I remember that this topic has been discussed before but I can't
>> remember when and where. Let me check on that.
>>
>> On Tue, Jul 19, 2011 at 4:06 PM, Kevin Meyer <ke...@kmz.co.za> wrote:
>>> Hi Rob,
>>>
>>> Indeed, that is a nice view into the change-set.
>>>
>>> The web-based svn browser Apache uses only supports diff views of
>>> individual files, with no obvious "entire commit" view.
>>>
>>> I'm with you on this one..
>>>
>>> Dan, btw, what did you do to link your commit to the JIRA view of ISIS-107?
>>>
>>> Regards,
>>> Kevin
>>>
>>>
>>> On Tue, July 19, 2011 14:19, Robert Matthews wrote:
>>>> I'm all for that (+1).  What happens for other changes - reforactorings
>>>> or small incremental improvements?
>>>>
>>>> While we are talking about change, I'm missing Trac terribly, and
>>>> specifically its view of the code base and most importantly its ability
>>>> to view the difference between revisions (see the original codebase ...
>>>> for an example).  This has helped me tremedously so many time to see
>>>> where changes are taking place and what has happened.
>>>
>>>
>>>> Is there anything similar in Apache? Does anyone know of other similar
>>>> tools (the source browsing/diffing part) that we could make use of?
>>>> (While Trac will allow you to use a mirrored repository I don't think
>>>> this would work with Isis as the repo is shared with all the other
>>>> projects - ie its too big!)
>>>>
>>>> Regards
>>>> Rob
>>>
>>>
>>>
>>
>>
>>
>> --
>> Thanks
>> - Mohammad Nour
>>   Author of (WebSphere Application Server Community Edition 2.0 User Guide)
>>   http://www.redbooks.ibm.com/abstracts/sg247585.html
>> - LinkedIn: http://www.linkedin.com/in/mnour
>> - Blog: http://tadabborat.blogspot.com
>> ----
>> "Life is like riding a bicycle. To keep your balance you must keep moving"
>> - Albert Einstein
>>
>> "Writing clean code is what you must do in order to call yourself a
>> professional. There is no reasonable excuse for doing anything less
>> than your best."
>> - Clean Code: A Handbook of Agile Software Craftsmanship
>>
>> "Stay hungry, stay foolish."
>> - Steve Jobs
>>
>
>
>
> --
> Thanks
> - Mohammad Nour
>   Author of (WebSphere Application Server Community Edition 2.0 User Guide)
>   http://www.redbooks.ibm.com/abstracts/sg247585.html
> - LinkedIn: http://www.linkedin.com/in/mnour
> - Blog: http://tadabborat.blogspot.com
> ----
> "Life is like riding a bicycle. To keep your balance you must keep moving"
> - Albert Einstein
>
> "Writing clean code is what you must do in order to call yourself a
> professional. There is no reasonable excuse for doing anything less
> than your best."
> - Clean Code: A Handbook of Agile Software Craftsmanship
>
> "Stay hungry, stay foolish."
> - Steve Jobs
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
Pingo, please have a look at [1] and [2]. Let me handle it.

[1] - https://fisheye6.atlassian.com/
[2] - https://fisheye6.atlassian.com/browse

On Tue, Jul 19, 2011 at 7:30 PM, Mohammad Nour El-Din
<no...@gmail.com> wrote:
> Hi...
>
>   I remember that this topic has been discussed before but I can't
> remember when and where. Let me check on that.
>
> On Tue, Jul 19, 2011 at 4:06 PM, Kevin Meyer <ke...@kmz.co.za> wrote:
>> Hi Rob,
>>
>> Indeed, that is a nice view into the change-set.
>>
>> The web-based svn browser Apache uses only supports diff views of
>> individual files, with no obvious "entire commit" view.
>>
>> I'm with you on this one..
>>
>> Dan, btw, what did you do to link your commit to the JIRA view of ISIS-107?
>>
>> Regards,
>> Kevin
>>
>>
>> On Tue, July 19, 2011 14:19, Robert Matthews wrote:
>>> I'm all for that (+1).  What happens for other changes - reforactorings
>>> or small incremental improvements?
>>>
>>> While we are talking about change, I'm missing Trac terribly, and
>>> specifically its view of the code base and most importantly its ability
>>> to view the difference between revisions (see the original codebase ...
>>> for an example).  This has helped me tremedously so many time to see
>>> where changes are taking place and what has happened.
>>
>>
>>> Is there anything similar in Apache? Does anyone know of other similar
>>> tools (the source browsing/diffing part) that we could make use of?
>>> (While Trac will allow you to use a mirrored repository I don't think
>>> this would work with Isis as the repo is shared with all the other
>>> projects - ie its too big!)
>>>
>>> Regards
>>> Rob
>>
>>
>>
>
>
>
> --
> Thanks
> - Mohammad Nour
>   Author of (WebSphere Application Server Community Edition 2.0 User Guide)
>   http://www.redbooks.ibm.com/abstracts/sg247585.html
> - LinkedIn: http://www.linkedin.com/in/mnour
> - Blog: http://tadabborat.blogspot.com
> ----
> "Life is like riding a bicycle. To keep your balance you must keep moving"
> - Albert Einstein
>
> "Writing clean code is what you must do in order to call yourself a
> professional. There is no reasonable excuse for doing anything less
> than your best."
> - Clean Code: A Handbook of Agile Software Craftsmanship
>
> "Stay hungry, stay foolish."
> - Steve Jobs
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
Hi...

   I remember that this topic has been discussed before but I can't
remember when and where. Let me check on that.

On Tue, Jul 19, 2011 at 4:06 PM, Kevin Meyer <ke...@kmz.co.za> wrote:
> Hi Rob,
>
> Indeed, that is a nice view into the change-set.
>
> The web-based svn browser Apache uses only supports diff views of
> individual files, with no obvious "entire commit" view.
>
> I'm with you on this one..
>
> Dan, btw, what did you do to link your commit to the JIRA view of ISIS-107?
>
> Regards,
> Kevin
>
>
> On Tue, July 19, 2011 14:19, Robert Matthews wrote:
>> I'm all for that (+1).  What happens for other changes - reforactorings
>> or small incremental improvements?
>>
>> While we are talking about change, I'm missing Trac terribly, and
>> specifically its view of the code base and most importantly its ability
>> to view the difference between revisions (see the original codebase ...
>> for an example).  This has helped me tremedously so many time to see
>> where changes are taking place and what has happened.
>
>
>> Is there anything similar in Apache? Does anyone know of other similar
>> tools (the source browsing/diffing part) that we could make use of?
>> (While Trac will allow you to use a mirrored repository I don't think
>> this would work with Isis as the repo is shared with all the other
>> projects - ie its too big!)
>>
>> Regards
>> Rob
>
>
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Kevin Meyer <ke...@kmz.co.za>.
Hi Rob,

Indeed, that is a nice view into the change-set.

The web-based svn browser Apache uses only supports diff views of
individual files, with no obvious "entire commit" view.

I'm with you on this one..

Dan, btw, what did you do to link your commit to the JIRA view of ISIS-107?

Regards,
Kevin


On Tue, July 19, 2011 14:19, Robert Matthews wrote:
> I'm all for that (+1).  What happens for other changes - reforactorings
> or small incremental improvements?
>
> While we are talking about change, I'm missing Trac terribly, and
> specifically its view of the code base and most importantly its ability
> to view the difference between revisions (see the original codebase ...
> for an example).  This has helped me tremedously so many time to see
> where changes are taking place and what has happened.


> Is there anything similar in Apache? Does anyone know of other similar
> tools (the source browsing/diffing part) that we could make use of?
> (While Trac will allow you to use a mirrored repository I don't think
> this would work with Isis as the repo is shared with all the other
> projects - ie its too big!)
>
> Regards
> Rob



Re: commit messages and JIRA

Posted by Siegfried Goeschl <sg...@gmx.at>.
Hi folks,

IMHO it is a good idea for large projects to trace code changes to JIRA 
tickets even when using umbrella tickets. And yes - there is nothing 
which prevents you to sneak in code changes using a unrelated JIRA 
ticket apart from peer pressure ... :-)

Cheers,

Siegfried Goeschl



On 20.07.11 11:59, Robert Matthews wrote:
> Indeed. But the slope goes both ways. How often do you then end up
> creating the tickets; or do you slip an improvement in behind another on
> another ticket.
>
> Let's go with umbrella ticket and revise the plan as we see fit. Along
> as we don't ignore that spelling mistake, leave in the poor formatting
> or forsake improving the codes readability then we'll be fine, but if we
> find ourselves thinking better of it then we should worry.
>
> Rob
>
> On 20/07/11 10:44, Dan Haywood wrote:
>> If we make an exception then it's a slippery slope... how small is small?
>>
>> It doesn't take long to create a new ticket in jira. My view is that
>> an umbrella ticket is a reasonable compromise.
>>
>> Dan
>>
>> Sent from my iPhone
>>
>> On 20 Jul 2011, at 10:07, Robert Matthews<rm...@nakedobjects.org>
>> wrote:
>>
>>> Could we not just agree on some commit heading that will cover these
>>> cases.
>>>
>>> On 20/07/11 07:41, Dan Haywood wrote:
>>>> On 19/07/2011 13:19, Robert Matthews wrote:
>>>>> I'm all for that (+1). What happens for other changes -
>>>>> reforactorings or small incremental improvements?
>>>> My suggestion is to create an umbrella ticket that will get closed
>>>> out for the release. For example, I created ISIS-107 for fixes to
>>>> documentation links on the website.
>>>>
>>>> Dan
>

Re: commit messages and JIRA

Posted by Dan Haywood <dk...@gmail.com>.
I've just committed a change to our site so that in future there is a 
link to Fisheye.

I've also just logged onto people.apache.org and patched our current 
site (a 3 line edit to index.html).  The change should be live within an 
hour or two.

Dan


On 21/07/2011 10:50, Mohammad Nour El-Din wrote:
> Guys, it is done ;) [1].
>
> [1] - http://fisheye6.atlassian.com/browse/isis
>
> On Wed, Jul 20, 2011 at 9:21 PM, Dan Haywood<dk...@gmail.com>  wrote:
>> On 20/07/2011 10:59, Robert Matthews wrote:
>>> Let's go with umbrella ticket and revise the plan as we see fit. Along as
>>> we don't ignore that spelling mistake, leave in the poor formatting or
>>> forsake improving the codes readability then we'll be fine, but if we find
>>> ourselves thinking better of it then we should worry.
>> Agreed, we don't want to have impediments to improving the codebase.  But on
>> the other hand if we want to build the community that has confidence in our
>> code then we should also follow - and be seen to be following - good
>> software engineering practices.
>>
>> At any rate... I've updated ISIS-107 to be for "miscellaneous edits" for the
>> Isis 0.2.0 release.    I've also changed it to have an issue type of
>> "Umbrella".
>>
>> Let's see how things go, as you say.
>>
>> Thx
>> Dan
>>
>>
>>> Rob
>>>
>>> On 20/07/11 10:44, Dan Haywood wrote:
>>>> If we make an exception then it's a slippery slope... how small is small?
>>>>
>>>> It doesn't take long to create a new ticket in jira.  My view is that an
>>>> umbrella ticket is a reasonable compromise.
>>>>
>>>> Dan
>
>

Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
Guys, it is done ;) [1].

[1] - http://fisheye6.atlassian.com/browse/isis

On Wed, Jul 20, 2011 at 9:21 PM, Dan Haywood <dk...@gmail.com> wrote:
>
> On 20/07/2011 10:59, Robert Matthews wrote:
>>
>> Let's go with umbrella ticket and revise the plan as we see fit. Along as
>> we don't ignore that spelling mistake, leave in the poor formatting or
>> forsake improving the codes readability then we'll be fine, but if we find
>> ourselves thinking better of it then we should worry.
>
> Agreed, we don't want to have impediments to improving the codebase.  But on
> the other hand if we want to build the community that has confidence in our
> code then we should also follow - and be seen to be following - good
> software engineering practices.
>
> At any rate... I've updated ISIS-107 to be for "miscellaneous edits" for the
> Isis 0.2.0 release.    I've also changed it to have an issue type of
> "Umbrella".
>
> Let's see how things go, as you say.
>
> Thx
> Dan
>
>
>>
>> Rob
>>
>> On 20/07/11 10:44, Dan Haywood wrote:
>>>
>>> If we make an exception then it's a slippery slope... how small is small?
>>>
>>> It doesn't take long to create a new ticket in jira.  My view is that an
>>> umbrella ticket is a reasonable compromise.
>>>
>>> Dan
>>
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Dan Haywood <dk...@gmail.com>.
On 20/07/2011 10:59, Robert Matthews wrote:
> Let's go with umbrella ticket and revise the plan as we see fit. Along 
> as we don't ignore that spelling mistake, leave in the poor formatting 
> or forsake improving the codes readability then we'll be fine, but if 
> we find ourselves thinking better of it then we should worry.

Agreed, we don't want to have impediments to improving the codebase.  
But on the other hand if we want to build the community that has 
confidence in our code then we should also follow - and be seen to be 
following - good software engineering practices.

At any rate... I've updated ISIS-107 to be for "miscellaneous edits" for 
the Isis 0.2.0 release.    I've also changed it to have an issue type of 
"Umbrella".

Let's see how things go, as you say.

Thx
Dan


>
> Rob
>
> On 20/07/11 10:44, Dan Haywood wrote:
>> If we make an exception then it's a slippery slope... how small is 
>> small?
>>
>> It doesn't take long to create a new ticket in jira.  My view is that 
>> an umbrella ticket is a reasonable compromise.
>>
>> Dan
>

Re: commit messages and JIRA

Posted by Robert Matthews <rm...@nakedobjects.org>.
Indeed. But the slope goes both ways. How often do you then end up 
creating the tickets; or do you slip an improvement in behind another on 
another ticket.

Let's go with umbrella ticket and revise the plan as we see fit. Along 
as we don't ignore that spelling mistake, leave in the poor formatting 
or forsake improving the codes readability then we'll be fine, but if we 
find ourselves thinking better of it then we should worry.

Rob

On 20/07/11 10:44, Dan Haywood wrote:
> If we make an exception then it's a slippery slope... how small is small?
>
> It doesn't take long to create a new ticket in jira.  My view is that an umbrella ticket is a reasonable compromise.
>
> Dan
>
> Sent from my iPhone
>
> On 20 Jul 2011, at 10:07, Robert Matthews<rm...@nakedobjects.org>  wrote:
>
>> Could we not just agree on some commit heading that will cover these cases.
>>
>> On 20/07/11 07:41, Dan Haywood wrote:
>>> On 19/07/2011 13:19, Robert Matthews wrote:
>>>> I'm all for that (+1).  What happens for other changes - reforactorings or small incremental improvements?
>>> My suggestion is to create an umbrella ticket that will get closed out for the release.  For example, I created ISIS-107 for fixes to documentation links on the website.
>>>
>>> Dan

Re: commit messages and JIRA

Posted by Dan Haywood <da...@haywood-associates.co.uk>.
If we make an exception then it's a slippery slope... how small is small?

It doesn't take long to create a new ticket in jira.  My view is that an umbrella ticket is a reasonable compromise. 

Dan

Sent from my iPhone

On 20 Jul 2011, at 10:07, Robert Matthews <rm...@nakedobjects.org> wrote:

> Could we not just agree on some commit heading that will cover these cases.
> 
> On 20/07/11 07:41, Dan Haywood wrote:
>> 
>> On 19/07/2011 13:19, Robert Matthews wrote:
>>> I'm all for that (+1).  What happens for other changes - reforactorings or small incremental improvements?
>> 
>> My suggestion is to create an umbrella ticket that will get closed out for the release.  For example, I created ISIS-107 for fixes to documentation links on the website.
>> 
>> Dan

Re: commit messages and JIRA

Posted by Robert Matthews <rm...@nakedobjects.org>.
Could we not just agree on some commit heading that will cover these cases.

On 20/07/11 07:41, Dan Haywood wrote:
>
> On 19/07/2011 13:19, Robert Matthews wrote:
>> I'm all for that (+1).  What happens for other changes - 
>> reforactorings or small incremental improvements?
>
> My suggestion is to create an umbrella ticket that will get closed out 
> for the release.  For example, I created ISIS-107 for fixes to 
> documentation links on the website.
>
> Dan

Re: commit messages and JIRA

Posted by Dan Haywood <dk...@gmail.com>.
On 19/07/2011 13:19, Robert Matthews wrote:
> I'm all for that (+1).  What happens for other changes - 
> reforactorings or small incremental improvements?

My suggestion is to create an umbrella ticket that will get closed out 
for the release.  For example, I created ISIS-107 for fixes to 
documentation links on the website.

Dan

Re: commit messages and JIRA

Posted by Robert Matthews <rm...@nakedobjects.org>.
I'm all for that (+1).  What happens for other changes - reforactorings 
or small incremental improvements?

While we are talking about change, I'm missing Trac terribly, and 
specifically its view of the code base and most importantly its ability 
to view the difference between revisions (see the original codebase at 
http://contributors.nakedobjects.org/trac/changeset?new=14810%40framework%2Ftrunk%2Fcore%2Fwebserver&old=14736%40framework%2Ftrunk%2Fcore%2Fwebserver 
<http://contributors.nakedobjects.org/trac/changeset?new=14810%40framework%2Ftrunk%2Fcore%2Fwebserver&old=14736%40framework%2Ftrunk%2Fcore%2Fwebserver> 
for an example).  This has helped me tremedously so many time to see 
where changes are taking place and what has happened.

Is there anything similar in Apache? Does anyone know of other similar 
tools (the source browsing/diffing part) that we could make use of? 
(While Trac will allow you to use a mirrored repository I don't think 
this would work with Isis as the repo is shared with all the other 
projects - ie its too big!)

Regards
Rob



On 17/07/11 17:23, Dan Haywood wrote:
> Now that we have a first release out, I'd like to ensure that there's 
> some traceability in changes being made...   That way we can be sure 
> that our release notes for subsequent releases will be reasonably 
> comprehensive, as well as meaning that users will gain confidence in 
> us as being a properly-run project.
>
> So, what I'd like to propose that any commits that we do to the 
> codebase are cross-referenced to a JIRA ticket.  For example, if 
> working on ISIS-105, then the commit message should be something like: 
> "ISIS-105: sorted out formatting".
>
> Opinions?
>
> Thanks
> Dan
>

Re: commit messages and JIRA

Posted by Mohammad Nour El-Din <no...@gmail.com>.
A very big +1

I think we definitely SHOULD do that if not MUST. It helped me a lot
for tracing changes in my work. Also I would recommend something that
we use here, which I proposed and also helps to have double linking
between JIRA and SVN, that is when resolving the JIRA task I asked my
team to comment on that task with the revision number in which they
committed code related to that one.

On Sun, Jul 17, 2011 at 8:51 PM, Kevin Meyer - KMZ <ke...@kmz.co.za> wrote:
> Hi Dan,
>
> Sounds like a plan - it'll also (help) ensure that JIRA tickets get created
> for all mods.
>
> Regards,
> Kevin
>
>
> On 17 Jul 2011 at 17:23, Dan Haywood wrote:
>
>> Now that we have a first release out, I'd like to ensure that there's
>> some traceability in changes being made...   That way we can be sure
>> that our release notes for subsequent releases will be reasonably
>> comprehensive, as well as meaning that users will gain confidence in us
>> as being a properly-run project.
>>
>> So, what I'd like to propose that any commits that we do to the codebase
>> are cross-referenced to a JIRA ticket.  For example, if working on
>> ISIS-105, then the commit message should be something like: "ISIS-105:
>> sorted out formatting".
>>
>> Opinions?
>>
>> Thanks
>> Dan
>
>
>



-- 
Thanks
- Mohammad Nour
  Author of (WebSphere Application Server Community Edition 2.0 User Guide)
  http://www.redbooks.ibm.com/abstracts/sg247585.html
- LinkedIn: http://www.linkedin.com/in/mnour
- Blog: http://tadabborat.blogspot.com
----
"Life is like riding a bicycle. To keep your balance you must keep moving"
- Albert Einstein

"Writing clean code is what you must do in order to call yourself a
professional. There is no reasonable excuse for doing anything less
than your best."
- Clean Code: A Handbook of Agile Software Craftsmanship

"Stay hungry, stay foolish."
- Steve Jobs

Re: commit messages and JIRA

Posted by Kevin Meyer - KMZ <ke...@kmz.co.za>.
Hi Dan,

Sounds like a plan - it'll also (help) ensure that JIRA tickets get created 
for all mods.

Regards,
Kevin


On 17 Jul 2011 at 17:23, Dan Haywood wrote:

> Now that we have a first release out, I'd like to ensure that there's 
> some traceability in changes being made...   That way we can be sure 
> that our release notes for subsequent releases will be reasonably 
> comprehensive, as well as meaning that users will gain confidence in us 
> as being a properly-run project.
> 
> So, what I'd like to propose that any commits that we do to the codebase 
> are cross-referenced to a JIRA ticket.  For example, if working on 
> ISIS-105, then the commit message should be something like: "ISIS-105: 
> sorted out formatting".
> 
> Opinions?
> 
> Thanks
> Dan