doc/developers.txt

   1 ==================
   2 Developing Roundup
   3 ==================
   4
   5 :Version: $Revision: 1.4 $
   6
   7 Note: the intended audience of this document is the developers of the core
   8 Roundup code. If you just wish to alter some behaviour of your Roundup
   9 installation, see `customising roundup`_.
  10
  11 .. contents::
  12
  13 Getting Started
  14 ---------------
  15
  16 Anyone wishing to help in the development of Roundup must read `Roundup's
  17 Design Document`_ and the `implementation notes`_.
  18
  19 All development is coordinated through two resources:
  20
  21 - roundup-dev mailing list at
  22   http://lists.sourceforge.net/mailman/listinfo/roundup-devel
  23 - Sourceforge's issue trackers at
  24   https://sourceforge.net/tracker/?group_id=31577
  25
  26 Small Changes
  27 -------------
  28
  29 Most small changes can be submitted through the Feature tracker, with patches
  30 attached that give context diffs of the affected source.
  31
  32
  33 CVS Access
  34 ----------
  35
  36 To get CVS access, contact richard@users.sourceforge.net.
  37
  38
  39 Project Rules
  40 -------------
  41
  42 Mostly the project follows Guido's Style (though naming tends to be a little
  43 relaxed sometimes). In short:
  44
  45 - 80 column width code
  46 - 4-space indentations
  47 - All modules must have a CVS Id line near the top, and a CVS Log at the end
  48
  49 Other project rules:
  50
  51 - New functionality must be documented, even briefly (so at least we know
  52   where there's missing documentation) and changes to tracker configuration
  53   must be logged in the upgrading document.
  54 - subscribe to roundup-checkins to receive checkin notifications from the
  55   other developers with CVS access
  56 - discuss any changes with the other developers on roundup-dev. If nothing
  57   else, this makes sure there's no rude shocks
  58 - write unit tests for changes you make (where possible), and ensure that
  59   all unit tests run before committing changes
  60 - run pychecker over changed code
  61
  62 The administrators of the project reserve the right to boot developers who
  63 consistently check in code which is either broken or takes the codebase in
  64 directions that have not been agreed to.
  65
  66
  67 -----------------
  68
  69 Back to `Table of Contents`_
  70
  71 .. _`Table of Contents`: index.html
  72 .. _`Customising Roundup`: customizing.html
  73 .. _`Roundup's Design Document`: spec.html
  74 .. _`implementation notes`: implementation.html