August 12, 2013

Legacy project - improving code quality by identifying technical debt

I have always worked on new projects where we decide what technologies/framework/language to use. It is easier to follow good development practices from day one and Continuous delivery in a project is the new norm. More often large enterprises have a legacy projects that has to be maintained and enhanced with new features. 

I recently had an opportunity to work on a consulting assignment where we had to work with client team, up skill them with good development practices and move towards continuous delivery model for their business critical application. It was a large program with 7 scrum teams and each team having 6-8 members. We initially started with couple of scrum teams as a POC(Proof of Concept) and tried to identify the issues/blockers in the process. These are the steps we followed while we tried to improve the code quality of a legacy project.

1. Identifying what to fix
Every project that has good and bad parts of the code. First step in improving a legacy project is to identify what needs to be fixed in the existing system.  
  • List the high risk areas in the codebase based on experience - There will be some parts of the code that no developer wants to touch. Every time we make a change to that piece of code hell breaks loose. Identify those classes/modules and categorize it as High/Medium/Low.
  • Run static code analysis tool (like Sonar for Java project) - Static code analysis tools immediately shows you the current state of the code.
  • Generate Heatmap from Version Control - There are few parts of the code that gets modified very frequently. It is important to identify those classes so that it can be refactored to smaller classes, wrapped with unit tests to improve resilience. 
  • Heatmap - Identify frequent code checkins for fixing bugs. Based on the commit message identify the classes that get frequent bug fixs.     
2. Prioritizing the changes
  • Code which causes most of the defects
  • Code where the new enhancement work is going to happen
  • Bugs identified by the static code analysis tools
  • Refactor code to fix the cyclomatic complexity, large classes/methods, etc based on static code analysis (if it satisfies 1 & 2 conditions)
3. Items to exclude from scope
 This is one of the important lessons I learnt while dealing with legacy projects. If you come across a piece of code that is "working" and if there is no foreseeable changes happening in that code, don't fix/clean the code. Add it to the backlog of "code to be refactored" with a low priority. As a developer it is common to have an urge to clean everything, but we should keep in mind that lot of companies/projects have gone bust by spending their time and money on rewriting software. 
         
4. Scheduling the changes as part of on going work
Once the backlog of tech debt has been identified, we need to plan it as part of on-going project work. Avoid the idea of spending dedicate time (few sprints/months) just for refactoring. This would not fly well with business as they don't see any returns after few months of refactoring.     
I would recommend spending 10% - 40% of each sprint capacity to fixing the Tech debt based on the backlog you had come up with.
Also, In agile world, don't add story points to tech debt stories. You are not delivering new "business value" and it should reflect in the velocity. It would make it obvious to the business on how much time is invested in tech debt and over time velocity would increase as the tech debt decreases.

5. Prepare the team 
If the team is not familiar with TDD and other development practices, it would help in training the team before venturing into refactoring. 
          - TDD techniques
          - Design patters
          - Pair programming
          - Brown bag sessions
          - Code showcase
Few recommended books:
  • Refactoring
  • TDD
  • Working with Legacy code
  • Refactoring DB
  • Pragmatic Programmer 
6. Working on the improvements
  • Hire expert/coach to help team on the job (CRITICAL)
  • Break the silos (Architects, DBA, etc)
  • Retrospect frequently
  • Identify, raise and fix the blockers.
  • Improve efficiency
    • Invest in new infrastructure (Cloud - is not a differentiator, a necessity)
    • Find alternate tools (Tomcat instead of Websphere, Weblogic, etc, Local database for each developer)
    • Good IDE environment
      • Emphasis on using shortcuts
      • Never write code if IDE can generate
    • Faster build
    • Identify bottlenecks
7. Track the improvements
  • Review the static code analysis metrics
  • Review the code coverage metrics
  • Introduce code coverage ratchet (Good and bad.. )
  • Track individual commits
  • Build a dashboard
  • GREEN build is a must
  • Don't refactor if it is not in the prioritized list. This is a important item to track as it would increase the scope of work.
Testing Process & Deployment Process improvements:
Will be covered in the next blog post.    

19 comments:

  1. Thank you for such a well written article. It’s full of insightful information and entertaining descriptions. Your point of view is the best among many. holistic healing

    ReplyDelete
  2. first of all i wanna say to all bloggers.
    and u aslo should visit on
    education is the eye of man

    ReplyDelete
  3. I can see that you are an expert at your field! I am launching a website soon, and your information will be very useful for me.. Thanks for all your help and wishing you all the success in your business. 5000 loan

    ReplyDelete
  4. I wanted to thank you for this excellent read!! I definitely loved every little bit of it. I have you bookmarked your site to check out the new stuff you post. procedura di sovraindebitamento

    ReplyDelete
  5. We have sell some products of different custom boxes.it is very useful and very low price please visits this site thanks and please share this post with your friends. 카지노사이트

    ReplyDelete
  6. Yes i am totally agreed with this article and i just want say that this article is very nice and very informative article.I will make sure to be reading your blog more. You made a good point but I can't help but wonder, what about the other side? !!!!!!Thanks consulenza fiscale

    ReplyDelete
  7. Hello I am so delighted I located your blog, I really located you by mistake, while I was watching on google for something else, Anyways I am here now and could just like to say thank for a tremendous post and a all round entertaining website. Please do keep up the great work. leather dog collars and leashes factory in Ubrique Spain

    ReplyDelete
  8. I’m going to read this. I’ll be sure to come back. thanks for sharing. and also This article gives the light in which we can observe the reality. this is very nice one and gives indepth information. thanks for this nice article... 송파 대우이안 이스트원 아파트

    ReplyDelete
  9. I wanted to thank you for this excellent read!! I definitely loved every little bit of it. I have you bookmarked your site to check out the new stuff you post. 여유증수술

    ReplyDelete
  10. I admire this article for the well-researched content and excellent wording. I got so involved in this material that I couldn’t stop reading. I am impressed with your work and skill. Thank you so much. บาคาร่า

    ReplyDelete
  11. Wow, cool post. I'd like to write like this too - taking time and real hard work to make a great article... but I put things off too much and never seem to get started. Thanks though. สล็อตออนไลน์

    ReplyDelete
  12. You there, this is really good post here. Thanks for taking the time to post such valuable information. Quality content is what always gets the visitors coming. สล็อต

    ReplyDelete
  13. I admire this article for the well-researched content and excellent wording. I got so involved in this material that I couldn’t stop reading. I am impressed with your work and skill. Thank you so much. slot machine

    ReplyDelete
  14. This is highly informatics, crisp and clear. I think that everything has been described in systematic manner so that reader could get maximum information and learn many things. slot

    ReplyDelete
  15. Excellent article. Very interesting to read. I really love to read such a nice article. Thanks! keep rocking. acompanhante masculino

    ReplyDelete
  16. I am definitely enjoying your website. You definitely have some great insight and great stories. acompanhante masculino

    ReplyDelete
  17. We have sell some products of different custom boxes.it is very useful and very low price please visits this site thanks and please share this post with your friends. Entrümpelung

    ReplyDelete