That's Not My Code!

That’s not my code!@MicheleTitolo

Thursday, May 15, 14






The Art of Code


Purpose


What are you trying to solve?


Fixing a bug?


Adding a new feature?


Updating a web API?


This helps focus your search


First thing’s first.


Does it build?


No! Wait!


You can and will learn a lot before building


Meta Information


Who? What? When? Where?


Why? How?


Who? What? When? Where?


Who?


Source Control


git log


Or use a GUI


How many people?


Are all the commits by one user?


Are the commit messages useful?


Xcode File Headers


//// MRTViewController.m// Awesome App//// Created by Michele Titolo on 5/03/14.// Copyright (c) 2014 Awesome Co. All rights reserved.//


Find in Project


grep


Were the files mostly created by one person?


Were they created by 17 people?


Too many cooks in the kitchen


Common encounters


One shop, two shopred shop, blue shop


Bifurcated code


No source control?No names in headers?


This tells you about the client


What?


Use the app


There will be things you don’t understand until you use it.



Use the app


Ask questions


Identify edge cases


...because you will have to deal with them


Oh, and write all of this down


Future you will thank you


When?


What iOS version?


What version was it built for?


Updating iOS 4 apps is a PITA


Backwards compatibility?


Is it using new stuff?


How is it checking version?


The further back, the more fragile the code will be


Gaps in development?


If it went months untouched, why?


Years?


Technical Debt


Where?


Contractors? In-House? Shop?


In-house -> out-of-house


Contractors - who?


Dev Shops


Outsourced?


Not written by someone who’s native language is yours


i.e. “colour” vs “color”


iOS Experience?


Internationalization


What countries is the app available?


What languages are supported?


The Code


The fun part!


Why?


Who, What, When, Where


Just don’t jump to conclusions


How?


File Structure


Xcode vs HD


Images


Make a map of where everything is


Building


Does it compile?


...because it doesn’t always


Missing dependencies?


Weird build settings?


Warnings


Number


Severity


#warning


Comments


TODO, FIXME, ???, $#^@!


Documentation?


Headers


README


The .pch


Tests


Dependencies


Submodules


CocoaPods


???


The Art of Code


Who, What, Where, When, Why, How


Art takes time


Art takes patience


Code takes time


Code takes patience


Thanks!@MicheleTitolo


Software

That's Not My Code!