PHP Code Review Checklist

I recently created a code review checklist for a PHP based project I was working on.  If you want to be pedantic, it's actually a list of questions that the reviewers should ask themselves as they look through the code.

This isn't an exhaustive list and it's not meant to be.  The only thing you will get from making an all-encompasing code review checklist is a list the your reviewers will ignore.  I'm depending on my team to be smart, autonomous, rational, and wise.  Perhaps I am idealistic, or maybe I'm just lucky to work with a great group of engineers.  The final version is still under development, but I wanted to share what I think is important when doing a "formal" code review.

Questions to consider while reviewing code:

1. Is the code readable as written?  Does it require additional comments, better naming, or general refactoring to be easily understandable?  Does the code generally conform to the style of coding for the project?
2. Does each function contain a (very) brief comment describing functionality, inputs, and outputs?
3. Does new code keep business logic away from presentation code?
4. Is identical functionality repeated multiple places in the code base?
5. Are there any code blocks that should be abstracted into functions or classes for maintainability?
6. Are there any hard coded constants that could possible change in the future?
7. Are all reasonable error conditions handled?

These questions are shaped by my personal experiences and the kinds of projects that I work on.  Some of them won't be applicable to another project, or even if they are applicable, they might not be necessary. They are also very subjective.  Decisions made while writing software are rarely black and white.  What is readable code for one person might be opaque for another coder who has a different skill set.  "Reasonable" error conditions may differ based on how critical this application is.  Consequently, I think code reviews are best when they are discussions and opportunity for learning.

There was another group of questions that I thought were important, but aren't really code related.  They probalby won't become part of our checklist, but I think they are interesting none the less.

1. Are the requirements formalized in writing and tracked/managed properly?
2. Are the requirements clear and unambiguous?
3. Is there a testable scenario that can exercise the new/changed requirements?
4. Was the code tested by someone other than the author? 
5. Did the modified code satisfy all the current system requirements?
6. Did the test scenarios exercise all the changed code paths?  If not, is there a good reason for that?

For me these questions are more like project wide diagnostic tests.  If you are running over schedule or you are getting a lot of bug reports back from the downstream users, asking these questions may help explain why the code creation process isn't performing as well as expected.

Comments

[ozlrbulvpl]

Leather sneakers repair Buckskin footwear for the reason that the majority of treasured some sort of footwear, Karen Millen Coat this each day use certain humps, Karen Millen Sale how can many of us look after leather-based boots and shoes? may. Karen Millen Ireland : http://www.ukarenmillendresses.com/ Leather-based shoes and boots that will be aware of what exactly areas retain? Avoiding most of within a set shoes and boots upkeep belonging to the malfunction, karen millen store to suit your needs an entire reply. Leather footwear servicing fault a: wet days to weeks could leather boots and shoes or perhaps boots as soon as wear boots. Leather shoes maintenance error 2: consider will be the extremes with sneakers, incredibly breathable, put on every single day. In addition to reasonable length of time involving wearing a pair of shoes, this cortex the result of white-colored foam using outside stuff that is cortical out and about the challenge. The particular house sneakers or even definitely not is the quality of this set shoes and boots don plus protection will be beneficial. If you are high quality will be very good along with the upkeep is likewise good, can easily gain curently have the reason for financial positive aspects.

Leather-based sneakers COMMON QUESTIONS preservation Queen: the key reason why are unable to the rainy day don leather-based footwear?
Any: certainly not donning set shoes wet day time, leather sneakers buckskin and also whether your skin layer, may drinking water laundry (exclusive water-proof taken off outside the house), set footwear together with waterproof houses will be poorer, leather dread drinking water, adhesive meet up with water possesses decrease alternative functionality, could glimpse KaiJiao happening. Along with the provide of the leather footwear while in the blisters, sometimes seam connected with buckskin sneakers, find soon after water may have the mildew plus effortless that they are busted. Leather-based is actually drinking water soak dry out hind, shed pounds, whenever usually do not look into product essential oil body fat, occasion increased, leather-based fibers are going to be busted and rupture. After the particular damp, have to be completed once cleaning measures it is in place them in dry out hue (will not towards sun's rays). At the same time, buckskin shoes and boots you should not and also acid solution, alkali, essential oil along with other detrimental element substance call, stay away from and also well-defined daunting products jointly airbrush, avert leather shoes and boots ruined. Queen: leather-based sneakers wet? Any: very first cleanup many of the dirt dust, reoccupy can cloth for you to blot humidity, make use of water imbibition good spend report towards number inside the shoe, in awesome in addition to dry within ventilated put. In case shoes is definitely wet, the idea ought to be frequently pertaining to substitution.

In no way while in the hot sunshine, or even wear because of the criticism baking. Leather-based footwear soon after dry out, remove on the little unripe hen essential oil, placed not one but two days to weeks after phone again shoeshineQ: how to stop brand-new DaJiao leather shoes and boots? The: if seem these kinds of scenario are available each time a humid sponge and also wrapped this DaJiao gleaming spot, a couple of hours and also consequently, take out A new drenched sponge or maybe fabric, using the palm to carry to come back, and also frequently on the portions of your DaJiao right up until melted, after which in awesome and also waterless it throughout venting, which has a bit of unripe bird gas (puppy fat) or maybe utilize the walnuts erase, after the sort the idea yet again after the shoeshine in in their foot within pure finalize the look. Queen: how can certainly not don set sneakers whenever kept? The: you should not put on footwear modify dresses according to the best that will crystal clear your particles for the surface from the set sneakers filth, place in A hip ventilated waterless it within the normal water, in the event that with mold; The house boots and shoes about the primary waterless a new part connected with dog fat, wiped frequently, next reach a shoeshine part, reduce buckskin footwear as well as harden, drop grease fracture. Last but not least, shoes and boots plus cushioning assistance fill inside the boot set sneakers the check out version. Q: buckskin sneakers having mold identify? A new: house footwear that therapy technique of mold spot. Clear waters out there, formidable gentle gauze dips within receive a handful of alcohol consumption is definitely wiped, after that click a new shoeshine level. Q: include toes sweat? Any: right after putting on house sneakers should be saved waterless inside the casino shoe, specific include ft perspire, whom usually alter the particular insole, the higher quality in order to many buckskin shoes and boots switch to be able to don. When wear leather shoes the matters needing attention 1, use anti-static shoes put must be anti-static ground (fresh); 2, wear anti-static footwear shouldn't additionally use the particular margin of your heavy constructed from wool socks plus insulation in the shoe mat; 3, only and supports to have efficiency materials; 4, anti-static shoes to wear after period of time (usually less than 200 h) should be resistance test, next thought he would wash or perhaps substitute You're feeling karen millen british isles several strategies of this? long year acer trends show only 001 more acelenolysunci topics now pr65 in 2012