Mercurial > p > roundup > code
comparison doc/developers.txt @ 935:2abb6b2697b6
doc updates
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 15 Aug 2002 00:39:51 +0000 |
| parents | b38f4f95bffd |
| children | 43ab730ee194 |
comparison
equal
deleted
inserted
replaced
| 934:fdcf16b444a9 | 935:2abb6b2697b6 |
|---|---|
| 1 ================== | 1 ================== |
| 2 Developing Roundup | 2 Developing Roundup |
| 3 ================== | 3 ================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.2 $ | 5 :Version: $Revision: 1.3 $ |
| 6 | 6 |
| 7 Note: the intended audience of this document is the developers of the core | 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 | 8 Roundup code. If you just wish to alter some behaviour of your Roundup |
| 9 installation, see `customising roundup`_. | 9 installation, see `customising roundup`_. |
| 10 | 10 |
| 33 CVS Access | 33 CVS Access |
| 34 ---------- | 34 ---------- |
| 35 | 35 |
| 36 To get CVS access, contact richard@users.sourceforge.net. | 36 To get CVS access, contact richard@users.sourceforge.net. |
| 37 | 37 |
| 38 Developers with CVS access should follow these simple guidelines: | |
| 39 | 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 instance configuration | |
| 53 must be logged in the upgrading document. | |
| 40 - subscribe to roundup-checkins to receive checkin notifications from the | 54 - subscribe to roundup-checkins to receive checkin notifications from the |
| 41 other developers with CVS access | 55 other developers with CVS access |
| 42 - discuss any changes with the other developers on roundup-dev. If nothing | 56 - discuss any changes with the other developers on roundup-dev. If nothing |
| 43 else, this makes sure there's no rude shocks | 57 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 | 58 - write unit tests for changes you make (where possible), and ensure that |
| 46 all unit tests run before committing changes | 59 all unit tests run before committing changes |
| 60 - run pychecker over changed code | |
| 47 | 61 |
| 48 The administrators of the project reserve the right to boot developers who | 62 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 | 63 consistently check in code which is either broken or takes the codebase in |
| 50 directions that have not been agreed to. | 64 directions that have not been agreed to. |
| 51 | 65 |