• Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL

Chapter 18. Browsing the Code > Check-in Requirements

Check-in Requirements

The check-in process is basically a series of established steps that must be followed in order. Don’t skip a step for any reason. From the beginning, the check-in process is as follows:

  1. Write code, whether it is a patch for a bug or new code for additional (new) functionality. After your code is complete, you need to check out the latest version of Firefox from the CVS system. Without the latest version, the changes might break another patch or new component. If what you are doing is going to take a longer time (say, a week or more), you should check out the latest version from CVS from time to time.

  2. Update your local tree (the source). Before checking out the source tree, first make sure that Tinderbox says the code is green—that is, it builds and tests okay. It is worthless to check out code while the tree is not green because your builds will not be reliable. Red means stop and green means go.

  3. Have your work reviewed. It must be reviewed before it can be added to the tree. This review serves as a check to ensure that whatever was done is acceptable (for instance, that the coding style and syntax are correct). No code is ever added to the project without review. Reviews are done by the module owner or someone who is designated by the module owner.

  4. Run prechecking tests. Established tests are already defined to test your code. Do not assume that your code will not have an adverse effect on other parts of the project. For information on precheck tests, visit http://www.Mozilla.org/quality/precheckin-tests.html.

  5. Check in your work. Tinderbox must indicate that the tree is open (allows check-in) and not closed (no check-ins are allowed). No check-in is allowed when the tree is red—that is, when the project will not properly build.

  6. Be responsible for your code. After your work has been checked in, you are responsible if it causes a problem! That is why you must do your precheck-in testing, and why the code must be reviewed.



Not a subscriber?

Start A Free Trial

  • Creative Edge
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint