Changes between Version 3 and Version 4 of WikiStart

Timestamp:

Mar 10, 2007, 1:25:10 PM (18 years ago)

Author:

cinc

Comment:

Added 'Contribute' section

WikiStart

@@ -12 +12 @@
 vendors can provide '''binary only''' extensions to the desktop.
 
+== How to contribute ==
 
+Before implementing new stuff drop a note on the Voyager mailing list.
+This prevents duplicate efforts if someone else is already working on the things you
+have in mind. In addition ML discussions make sure any patches fit into the overall
+architecture of the desktop.
+
+=== Patch policy ===
+
+Bug fixes may go directly into the tree. Enhancements of classes (like new methods) or
+completely new classes will first have a test drive for some time to make sure they fit
+in. Enhancements should be coded as replacement classes not as direct patches to existing
+classes. If you need to patch an exisiting class to get something done it's likely
+your design isn't optimal. This doesn't mean enhancement of existing classes to
+support new features in subclasses are rejected. If it turns out your enhancements are
+working flawlessly they will go into the main tree which means they will be added
+directly to the classes in question.
+
+=== Documentation ===
+
+Every new feature (e.g. methods) '''must''' be documented in the source using doxygen
+tags. See the existing source for examples.[[BR]]
+Comment your code thouroughly even if you think comments are not necessary because anyone
+should be able to understand your code.
+
+
+Patches without proper comments or doxygen documentation will be rejected without discussion.
+
+=== Coding style ===
+
+ Function and method names::
+  Names are not build with underscores like in the GLib toolkit. Instead uppercase letters
+  are used to separate name parts:
+
+  {{{  dont_use_this_as_a_name();}}}
+
+  {{{  thisIsCorrect(); }}}
+
+  The first letter is always lowercase. Note that this is true for all functions and methods in NOM.[[BR]]
+  In pure C libraries the first letter is usually uppercase. 
+
+ Variables::
+  Use verbose variables. i, j, k was ok last century but today we have compilers supporting really long
+  variable names. Verbose names make it easier for newcomers to understand your code. Prepend your variables
+  with a meaningful marker (e.g. i for int).
+
+  {{{
+  #!c
+  int main(int argc, char *argv[])
+    {
+    /* This is not ok */
+    gint i, k;
+    char* p;
+
+    printf("Hello World\n");
+    ...
+    }
+ }}}
+
+  {{{
+  #!c
+  int main(int argc, char *argv[])
+    {
+    /* Use something like this */
+    gint iLoop, iNumberOfItems;
+    gulong ulSize;
+    char* pString;
+
+    printf("Hello World\n");
+    ...
+    }
+ }}}
+