doc/DEVELOPERS

   1
   2 A FEW THOUGHTS TO FUTURE MAINTAINERS/DEVELOPERS/HACKERS
   3 =======================================================
   4
   5   - If you feel compelled to add more compile-time options (i.e., Java
   6     support, etc.), please follow the "NO_" and "NEED_" conventions in the
   7     make files. Also, add code as appropriate to menus.c:Identify() and
   8     parse.c:make_m4_cmdline().
   9
  10   - Likewise, please follow what few coding conventions are in place. Don't
  11     use C++'s double-slash comments, keep up with the K&R style functions,
  12     etc.
  13
  14   - Keep VTWM portable. There are only two "#ifdef __PLATFORM__"s in this
  15     code, yet it runs on platforms I've never seen. GNU isn't everywhere.
  16     Neither is POSIX or ANSI. Seek out variety through beta-testers in the
  17     X-related newsgroups. Finally, remember that it's X11R4 compliant.
  18
  19   - Just because you can't live without such-and-such doesn't mean everyone
  20     can't. It's a window manager, not an environment. Help keep VTWM lean.
  21
  22   - Add no memory leaks! I haven't read every line of this code, but have
  23     had to fix very few, and have seen that none have been introduced.
  24     'Nuff said 'bout that.
  25
  26   - Document! The code is a long commentary on VTWM's evolution, and though
  27     it does get hard to read, I've come to think it a Good Thing. Keep the
  28     files in the in the doc directory current.
  29
  30 Sorry if this reads a little belligerent. I'm just tired of fighting all
  31 sorts of platform-specific implementations and lazy coding practices while
  32 porting stuff. I'm sure you are too. VTWM should never be such. --- djhjr
  33