• Tuesday December 2nd 2008
• Do you want fries with that project?

Skip to Content

xulwidgets

resources:	Home Mailing List Installation Manual Test Cases Source Code Members Bugs Screenshots

Review Requirements

All code contributions

There are a number of requirements for any new XUL Widgets core code or extension development:

1. Source-level documentation.  Any new code you write must be commented until it is very clear what the code should do.
2. JavaDoc-style documentation of functions.  Explain clearly what the functions do.
3. Documentation in this manual.  Explain clearly how the end-user should use your new code.
4. Errors and warnings kept to a minimum.  This means any errors and warnings must be thrown deliberately by you.
5. No spelling errors.  None!  (The exception is if mozilla.org misspellings force you to use them, and then only in those cases.  For instance, if an IDL-defined method name is misspelled.)
   
6. No anonymous functions.  function() {} is forbidden.
7. If you catch an exception, you must do more than discard them.  The following are acceptable:

   try
   {
     ...
   }
   catch (e)
   {
     // do nothing, but explain why
   }
   
   try
   {
     ...
   }
   catch (e)
   {
     dump(e);
   }
   

Last, but not least...

Be prepared to answer questions from reviewers.  Reviewers will ask questions!  Their questions do not mean that you are wrong.  Sometimes the reviewer might ask about something you've already considered and written an answer for, but they missed.

Also, treat your fellow developers, reviewers, bug reporters and users like people.