Steps towards regular code reviews

From Apache OpenOffice Wiki
Revision as of 13:04, 23 May 2007 by Np (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Scope

Some OOo developers at Sun in Hamburg have tried out regular Code Reviews for a few months and have found them to be helpful. Those code reviews are mainly for the goal of preventing defects by education; actual bug-finding is (though nice) a secondary effect.

Positive Experiences:

  • Easy learning of the OOo C++ Coding Standards
  • Frequent opportunities to learn from each other in the community
  • Learning about various parts of the Office, leading to a deeper understanding of the whole

... and as an effect of those all, reviews help to reach:

  • more correct and better maintainable code, less defects, higher quality.

Therefore, code reviews might be worth a try for more OOo developers. This page shall help to set up the opportunity for this.


Who is interested?

Put your name+email here, if you would like to try out code reviews. Than others can see your name and contact you



How to do Long-distance Reviews?

The reviews in the above mentioned experiment were all done in face-to-face meetings. The OOo-community however consists of people at many different locations. We need ideas, how to do that.

Enter ideas/suggestions below here.


IRC

One possibility would be to hold a review meeting via IRC after sending the code files per mail or checking them out from CVS.


Experiences

If you tried it out and have suggestions for improvement, put them here.


FAQ

Here we can start a FAQ.


Resources

Open questions are discussed on dev@openoffice.org.

Personal tools