HACKING

   1 ===Commit Permissions==
   2 Build sherrif commits are welcome.
   3
   4 If you are an experienced GNOME hacker and confident that your code is right,
   5 you don't need maintainer approval to commit to HEAD. You still need to get your patch
   6 reviewed by some other (competent) GNOME hacker.
   7
   8 If you are unsure of your change, please feel free to send the patch to
   9 gnome-vfs@gnome.org and get our approval so we won't execute you when it breaks
  10 things / does them wrong.
  11
  12 Please get approval for commits to the gnome-2-0 branch.
  13
  14
  15 ===Prior to Checkin===
  16 Create a ChangeLog entry
  17
  18 Get your code reviewed by an experienced GNOME hacker, who's participation you should
  19 cite in the ChangeLog entry by including a "Reviewed by:" line at the top of the entry.
  20
  21 Make sure that any API additions or changes are reflected correctly in the documentation.
  22
  23 Make sure your code does not generate warnings. Do not turn any warnings off, do not
  24 turn -Werror off in configure.in. If you have problems with the existing warnings building
  25 on your environment, please contact the maintainers.
  26
  27 Make sure your changes are properly tested, ammong other things run a "make check".
  28
  29 Please make sure components that depend on Gnome VFS (eg Nautilus, Evolution)
  30 do not break with your change or arrange that an update to the dependent
  31 components gets submitted at the same time.
  32
  33
  34 ===Style===
  35 Please use a coding style that is consistent with the existing Gnome VFS code.
  36 Gnome VFS uses the GNOME Programming Guidelines with 8-space tabs and a
  37 "K&R" indentation style.
  38
  39
  40 ===FIXMEs===
  41 Use "FIXME" to augument code that needs more work, that is missing functionality or
  42 in general needs attention. Include a comprehensive comment explaining what is
  43 missing, why you think something is broken, what you suggest as a fix, etc.
  44 FIXME entries are periodically converted into bugzilla bugs.
  45 Do not use any other format to draw attention to problems, comments that do
  46 not contain "FIXME" are not going to be found by our problem tracking tools.
  47
  48
  49 ===Feedback===
  50 GnomeVFS bugs and open tasks are tracked in http://bugzilla.gnome.org
  51
  52 For IRC help/feedback use irc.gnome.org/#nautilus.
  53
  54 A GnomeVFS mailing list is available at http://lists.gnome.org/