Refactoring code and JIRA

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

Refactoring code and JIRA

taher
Hi everyone,

Many times I have the itch to cleanup the code base but not sure whether a
JIRA issue is necessary.

Do i need to issue a JIRA for pure code refactoring (no functional change)?
This would include things like function and variable rename, breaking up
big classes and functions, adding unit tests, rewiring classes and so on.

Cheers

Taher Alkhateeb
Reply | Threaded
Open this post in threaded view
|

Re: Refactoring code and JIRA

Pierre Smits
HI Taher,

JIRA issues tell our users what to expect when it comes to
updating/upgrading their production environments. And it tells potential
adopters what they can expect.

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Wed, Dec 23, 2015 at 6:33 PM, Taher Alkhateeb <[hidden email]
> wrote:

> Hi everyone,
>
> Many times I have the itch to cleanup the code base but not sure whether a
> JIRA issue is necessary.
>
> Do i need to issue a JIRA for pure code refactoring (no functional change)?
> This would include things like function and variable rename, breaking up
> big classes and functions, adding unit tests, rewiring classes and so on.
>
> Cheers
>
> Taher Alkhateeb
>
Reply | Threaded
Open this post in threaded view
|

Re: Refactoring code and JIRA

Jacques Le Roux
Administrator
In reply to this post by taher
I assume pure code refactoring with no functional changes does not need a Jira.
But what you could do is many commits with a sole Jira issue, for people to refer in a sole place in case of need.

Jacques


Le 23/12/2015 18:33, Taher Alkhateeb a écrit :

> Hi everyone,
>
> Many times I have the itch to cleanup the code base but not sure whether a
> JIRA issue is necessary.
>
> Do i need to issue a JIRA for pure code refactoring (no functional change)?
> This would include things like function and variable rename, breaking up
> big classes and functions, adding unit tests, rewiring classes and so on.
>
> Cheers
>
> Taher Alkhateeb
>
Reply | Threaded
Open this post in threaded view
|

Re: Refactoring code and JIRA

taher
Thank you Jacques and Pierre

Ok so perhaps a middle ground is to have a central JIRA issue to which I
refer all commits. This way I can be lean in cleaning up the code base.

Oh and please disregard the other email, it was my bad for sending twice

Regards,

Taher Alkhateeb

On Wed, Dec 23, 2015 at 9:11 PM, Jacques Le Roux <
[hidden email]> wrote:

> I assume pure code refactoring with no functional changes does not need a
> Jira.
> But what you could do is many commits with a sole Jira issue, for people
> to refer in a sole place in case of need.
>
> Jacques
>
>
> Le 23/12/2015 18:33, Taher Alkhateeb a écrit :
>
>> Hi everyone,
>>
>> Many times I have the itch to cleanup the code base but not sure whether a
>> JIRA issue is necessary.
>>
>> Do i need to issue a JIRA for pure code refactoring (no functional
>> change)?
>> This would include things like function and variable rename, breaking up
>> big classes and functions, adding unit tests, rewiring classes and so on.
>>
>> Cheers
>>
>> Taher Alkhateeb
>>
>>
Reply | Threaded
Open this post in threaded view
|

Re: Refactoring code and JIRA

Ron Wheeler
If you raise a JIRA for each refactoring exercise then people can
comment on your plan.

The scope of the JIRA should be short so you can finish it, test it and
close it before a lot of other bugs/enhancements get done that might
affect the same code.

The scope should be short so that if you break anything, it is easy to
know what to revert - I know that you will not break anything but I am
speaking in general.

The scope should be short so that a release can be started with a finite
and well understood list of JIRAs to be fixed before the release is
ready to go.
I don't like a general JIRA since it would make it hard to tell how much
work was included and it would have no expected completion or any way to
estimate that.
Perhaps the lack of release strategy for OFBiz makes this a weak argument.

If the scope is well defined, others in the community can help if you
are not able to find time to finish it.

Ron


On 23/12/2015 1:28 PM, Taher Alkhateeb wrote:

> Thank you Jacques and Pierre
>
> Ok so perhaps a middle ground is to have a central JIRA issue to which I
> refer all commits. This way I can be lean in cleaning up the code base.
>
> Oh and please disregard the other email, it was my bad for sending twice
>
> Regards,
>
> Taher Alkhateeb
>
> On Wed, Dec 23, 2015 at 9:11 PM, Jacques Le Roux <
> [hidden email]> wrote:
>
>> I assume pure code refactoring with no functional changes does not need a
>> Jira.
>> But what you could do is many commits with a sole Jira issue, for people
>> to refer in a sole place in case of need.
>>
>> Jacques
>>
>>
>> Le 23/12/2015 18:33, Taher Alkhateeb a écrit :
>>
>>> Hi everyone,
>>>
>>> Many times I have the itch to cleanup the code base but not sure whether a
>>> JIRA issue is necessary.
>>>
>>> Do i need to issue a JIRA for pure code refactoring (no functional
>>> change)?
>>> This would include things like function and variable rename, breaking up
>>> big classes and functions, adding unit tests, rewiring classes and so on.
>>>
>>> Cheers
>>>
>>> Taher Alkhateeb
>>>
>>>


--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Reply | Threaded
Open this post in threaded view
|

Re: Refactoring code and JIRA

Nicolas Malin-2
In reply to this post by taher
Le 23/12/2015 19:28, Taher Alkhateeb a écrit :
> Ok so perhaps a middle ground is to have a central JIRA issue to which I
> refer all commits. This way I can be lean in cleaning up the code base.
Clearly it's good point to have a central issue, and maybe commit group
by cover.

Nicolas