doc/developers.txt

   1 ==================
   2 Developing Roundup
   3 ==================
   4
   5 :Version: $Revision: 1.2 $
   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 Developers with CVS access should follow these simple guidelines:
  39
  40 - subscribe to roundup-checkins to receive checkin notifications from the
  41   other developers with CVS access
  42 - discuss any changes with the other developers on roundup-dev. If nothing
  43   else, this makes sure there's no rude shocks
  44 - run pychecker over changed code
  45 - write unit tests for changes you make (where possible), and ensure that
  46   all unit tests run before committing changes
  47
  48 The administrators of the project reserve the right to boot developers who
  49 consistently check in code which is either broken or takes the codebase in
  50 directions that have not been agreed to.
  51
  52
  53 -----------------
  54
  55 Back to `Table of Contents`_
  56
  57 .. _`Table of Contents`: index.html
  58 .. _`Customising Roundup`: customizing.html
  59 .. _`Roundup's Design Document`: spec.html
  60 .. _`implementation notes`: implementation.html