Difference between revisions of "Steps towards regular code reviews"

From Apache OpenOffice Wiki
Jump to: navigation, search
(setting up page)
 
 
(One intermediate revision by one other user not shown)
Line 14: Line 14:
  
 
=== Who is interested? ===
 
=== 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''
+
==== Starters ====
 +
''Put your name + mail@ooo here, if you would like to try out code reviews. Than others can see your name and contact you''
  
 +
 +
==== Tutors ====
 +
''Put your name + mail@ooo here, if you already have done (educational) code reviews and are willing to join with a starter for his/her first review(s).''
  
  
Line 27: Line 31:
 
==== IRC ====
 
==== 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.
 
One possibility would be to hold a review meeting via IRC after sending the code files per mail or checking them out from CVS.
 +
 +
==== Netbeans Collaboration Toolset ====
 +
May be that could be helpful: http://cld.blog-city.com/netbeans_collaboration_project___collablets_and_codeaware_to.htm, collab.netbeans.org
 +
  
  
Line 43: Line 51:
 
* [[Cpp Coding Standards]]
 
* [[Cpp Coding Standards]]
 
Open questions are discussed on dev@openoffice.org.
 
Open questions are discussed on dev@openoffice.org.
 +
[[Category:Coding Standards]]

Latest revision as of 21:43, 21 March 2010

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?

Starters

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


Tutors

Put your name + mail@ooo here, if you already have done (educational) code reviews and are willing to join with a starter for his/her first review(s).


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.

Netbeans Collaboration Toolset

May be that could be helpful: http://cld.blog-city.com/netbeans_collaboration_project___collablets_and_codeaware_to.htm, collab.netbeans.org



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