view doc/developers.txt @ 825:0779ea9f1f18

More indexer work: - all String properties may now be indexed too. Currently there's a bit of "issue" specific code in the actual searching which needs to be addressed. In a nutshell: + pass 'indexme="yes"' as a String() property initialisation arg, eg: file = FileClass(db, "file", name=String(), type=String(), comment=String(indexme="yes")) + the comment will then be indexed and be searchable, with the results related back to the issue that the file is linked to - as a result of this work, the FileClass has a default MIME type that may be overridden in a subclass, or by the use of a "type" property as is done in the default templates. - the regeneration of the indexes (if necessary) is done once the schema is set up in the dbinit.
author Richard Jones <richard@users.sourceforge.net>
date Tue, 09 Jul 2002 03:02:53 +0000
parents b38f4f95bffd
children 2abb6b2697b6
line wrap: on
line source

==================
Developing Roundup
==================

:Version: $Revision: 1.2 $

Note: the intended audience of this document is the developers of the core
Roundup code. If you just wish to alter some behaviour of your Roundup
installation, see `customising roundup`_.

.. contents::

Getting Started
---------------

Anyone wishing to help in the development of Roundup must read `Roundup's
Design Document`_ and the `implementation notes`_.

All development is coordinated through two resources:

- roundup-dev mailing list at
  http://lists.sourceforge.net/mailman/listinfo/roundup-devel
- Sourceforge's issue trackers at
  https://sourceforge.net/tracker/?group_id=31577

Small Changes
-------------

Most small changes can be submitted through the Feature tracker, with patches
attached that give context diffs of the affected source.


CVS Access
----------

To get CVS access, contact richard@users.sourceforge.net.

Developers with CVS access should follow these simple guidelines:

- subscribe to roundup-checkins to receive checkin notifications from the
  other developers with CVS access
- discuss any changes with the other developers on roundup-dev. If nothing
  else, this makes sure there's no rude shocks
- run pychecker over changed code
- write unit tests for changes you make (where possible), and ensure that
  all unit tests run before committing changes

The administrators of the project reserve the right to boot developers who
consistently check in code which is either broken or takes the codebase in
directions that have not been agreed to.


-----------------

Back to `Table of Contents`_

.. _`Table of Contents`: index.html
.. _`Customising Roundup`: customizing.html
.. _`Roundup's Design Document`: spec.html
.. _`implementation notes`: implementation.html

Roundup Issue Tracker: http://roundup-tracker.org/