What to Do?

Introduction

So you have just been informed that your package is going to go through a code review.  What do you do now?  This page is meant to provide some guidance in helping you prepare.

Remember, it is not just up to the package owner to prepare for the review.  All developers that contribute to a package should be able to help with the work load.

What to do?

• Review the GLAST Coding Standards.
  • Are your variables and files named according to GLAST naming standards?
  • Are your line widths less than or equal to 80 characters?
• Review the latest code documentation recommendations, available from the Documentation Task Force home page.
  • Start with your mainpage.h file
    • Are all jobOptions parameters documented?
  • Check the release.notes - are they up to date?
  • Do all classes have a Doxygen class header providing an overview of the class?
  • Are Doxygen comments provided in all header files?
  • Do major methods have a standard C++ comment header?
  • Is the indentation consistent in all source and header files?
• Do you have a class diagram for your package?
• Test your Doxygen output on your local machine.
• Does your code compile and run on both Windows and Linux?
• Does your package have a test program?
  • Is it named appropriately?
  • Does it work? 
• 3 days before the review, tag your package and provide the tag to the reviewers.
  • This gives the reviewers time to look over the code and documentation.  The Doxygen pages will be generated from this tag.
  • If your package is not a checkout package, provide a list of versions of all used packages to test your package.