Mercurial > p > roundup > code

annotate doc/developers.txt @ 703:8d2cb0d09da4 search_indexing-0-4-2-branch

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed small bug that prevented indexes from being generated.
author Roche Compaan <rochecompaan@users.sourceforge.net>
date Thu, 02 May 2002 11:52:12 +0000
parents 3d8ce8e2dcee
children 54333751e98d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
691
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
1 ==================
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
2 Developing Roundup
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
3 ==================
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
4
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
5 :Version: $Revision: 1.2 $
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
6
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
7 Note: the intended audience of this document is the developers of the core
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
8 Roundup code. If you just wish to alter some behaviour of your Roundup
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
9 installation, see `customising roundup`_.
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
10
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
11 .. contents::
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
12
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
13 Getting Started
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
14 ---------------
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
15
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
16 Anyone wishing to help in the development of Roundup must read `Roundup's
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
17 Design Document`_ and the `implementation notes`_.
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
18
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
19 All development is coordinated through two resources:
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
20
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
21 - roundup-dev mailing list at
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
22 http://lists.sourceforge.net/mailman/listinfo/roundup-devel
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
23 - Sourceforge's issue trackers at
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
24 https://sourceforge.net/tracker/?group_id=31577
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
25
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
26 Small Changes
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
27 -------------
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
28
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
29 Most small changes can be submitted through the Feature tracker, with patches
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
30 attached that give context diffs of the affected source.
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
31
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
32
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
33 CVS Access
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
34 ----------
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
35
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
36 To get CVS access, contact richard@users.sourceforge.net.
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
37
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
38 Developers with CVS access should follow these simple guidelines:
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
39
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
40 - subscribe to roundup-checkins to receive checkin notifications from the
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
41 other developers with CVS access
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
42 - discuss any changes with the other developers on roundup-dev. If nothing
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
43 else, this makes sure there's no rude shocks
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
44 - run pychecker over changed code
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
45 - write unit tests for changes you make (where possible), and ensure that
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
46 all unit tests run before committing changes
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
47
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
48 The administrators of the project reserve the right to boot developers who
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
49 consistently check in code which is either broken or takes the codebase in
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
50 directions that have not been agreed to.
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
51
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
52
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
53 -----------------
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
54
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
55 Back to `Table of Contents`_
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
56
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
57 .. _`Table of Contents`: index.html
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
58 .. _`Customising Roundup`: customizing.html
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
59 .. _`Roundup's Design Document`: spec.html
3d8ce8e2dcee [[Metadata associated with this commit was garbled during conversion from CVS
Roche Compaan <rochecompaan@users.sourceforge.net>
parents:
diff changeset
60 .. _`implementation notes`: implementation.html
Roundup Issue Tracker: http://roundup-tracker.org/