This site is archived.

Using the Code Review module

stella's picture
Submitted by stella on Thu, 07/17/2008 - 17:54.

Session recording

Attached files

Co-presenters: 
Placement
Session time: 
08/30/2008 - 11:00 - 08/30/2008 - 12:00
Conference booklet summary and bio
Article for conference booklet: 
Drupal has a number of coding standards that all contributed Drupal modules and themes should be using. Instead of each developer coding in their own preferred style, they are asked to write all code according to the standards outlined in the document. This ensures that all of Drupal's code is written to a consistent standard, making it easier to understand and modify. This session will focus on the Code Review module (aka Coder). This is a useful developer tool which allows developers to ensure that their code meets the Drupal coding standards. It can also identify common security coding issues and provides a set of tests to assist developers when upgrading their modules to newer versions of Drupal. If you write or maintain Drupal code, you should be using this module. This session will allow you to see Coder in action. We'll run Coder on a module and discuss some of the common styling problems that Coder can identify for you. We'll also show you how Coder can assist you in upgrading your modules to Drupal 6 and how you can help improve Coder by submitting new rules. By the end of this session, attendees will have a good grounding in what the Coder module does and how they can use it to improve their modules and themes.
Bios for conference booklet: 
Stella Power starting using Drupal just over 2 years ago. Since then she has contributed the FAQ and Avatar Selection modules, and is co-maintainer of the popular Lightbox2 and Code Review modules. She is also a keen photographer and ceramic artist. Since joining the Drupal community in early 2006, Doug Green has contributed over 20 modules, most notably the coder module which is used by many Drupal developers to improve and upgrade their code. Doug is also involved with Drupal's core search features as the author of views_fastsearch, the Drupal 6.x core search improvements, and numerous other core patches. Doug holds a degree in Computer Science from Cornell University and has over 22 years of professional software development experience from C/C++ to php and everything between. A partner at CivicActions, Doug works with distributed teams of other developers and professionals "Changing the world one node at a time!"

Overview

The Code Review module (aka coder) is a useful tool for module and theme developers. It allows developers to ensure that their code meets the Drupal coding standards and also assists them in upgrading to newer versions of Drupal. If you write or maintain code (mostly modules, but themes too), you should be using this module.

Agenda
* Discussion of Common Style Problems that Coder identifies for you.
* We’ll run Coder on a module.
* We’ll show how to setup Coder to run it on ALL your modules.
* Overview of using Coder for upgrading modules to Drupal 6, including some examples.
* How to submit coder rules and help make Coder better.
* Floor Discussion on the direction Coder should take.
* Q&A session.

Goals
By the end of this session, attendees will have a good grounding in what the Coder module does and how they can use it to improve their modules / themes.

Resources
Attendees should already be familiar with basic Drupal module development.
* Coder project page - http://drupal.org/project/coder
* Drupal Coding Standards - http://drupal.org/node/318
* Converting 5.x modules to 6.x - http://drupal.org/node/114774
* Writing Coder Rules - http://drupal.org/node/144172