Mercurial > p > roundup > code
comparison doc/developers.txt @ 686:c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 10 Apr 2002 23:55:36 +0000 |
| parents | |
| children | b38f4f95bffd |
comparison
equal
deleted
inserted
replaced
| 685:de6dc74a4148 | 686:c52122f38c9b |
|---|---|
| 1 Developing Roundup | |
| 2 ================== | |
| 3 | |
| 4 :Version: $Revision: 1.1 $ | |
| 5 | |
| 6 Note: the intended audience of this document is the developers of the core | |
| 7 Roundup code. If you just wish to alter some behaviour of your Roundup | |
| 8 installation, see `customising roundup`_. | |
| 9 | |
| 10 .. contents:: | |
| 11 | |
| 12 Getting Started | |
| 13 --------------- | |
| 14 | |
| 15 Anyone wishing to help in the development of Roundup must read `Roundup's | |
| 16 Design Document`_. | |
| 17 | |
| 18 All development is coordinated through two resources: | |
| 19 | |
| 20 - roundup-dev mailing list at | |
| 21 http://lists.sourceforge.net/mailman/listinfo/roundup-devel | |
| 22 - Sourceforge's issue trackers at | |
| 23 https://sourceforge.net/tracker/?group_id=31577 | |
| 24 | |
| 25 Small Changes | |
| 26 ------------- | |
| 27 | |
| 28 Most small changes can be submitted through the Feature tracker, with patches | |
| 29 attached that give context diffs of the affected source. | |
| 30 | |
| 31 | |
| 32 CVS Access | |
| 33 ---------- | |
| 34 | |
| 35 To get CVS access, contact richard@users.sourceforge.net. | |
| 36 | |
| 37 Developers with CVS access should follow these simple guidelines: | |
| 38 | |
| 39 - subscribe to roundup-checkins to receive checkin notifications from the | |
| 40 other developers with CVS access | |
| 41 - discuss any changes with the other developers on roundup-dev. If nothing | |
| 42 else, this makes sure there's no rude shocks | |
| 43 - run pychecker over changed code | |
| 44 - write unit tests for changes you make (where possible), and ensure that | |
| 45 all unit tests run before committing changes | |
| 46 | |
| 47 The administrators of the project reserve the right to boot developers who | |
| 48 consistently check in code which is either broken or takes the codebase in | |
| 49 directions that have not been agreed to. | |
| 50 | |
| 51 | |
| 52 ----------------- | |
| 53 | |
| 54 Back to `Table of Contents`_ | |
| 55 | |
| 56 .. _`Table of Contents`: index.html | |
| 57 .. _`Customising Roundup`: customizing.html | |
| 58 .. _`Roundup's Design Document`: spec.html |